Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/spreed.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjoern Schiessle <bjoern@schiessle.org>2016-11-28 17:20:19 +0300
committerBjoern Schiessle <bjoern@schiessle.org>2016-11-28 17:20:19 +0300
commit3c57a4c34b5741687ad3d5f5f843292c328b51fc (patch)
tree0614ae99a68b8dc8a2297400e468867e31d649f4 /README.md
parentbf0341436de71e022fdd4bdb6a7cb87e1eafd5a6 (diff)
add a proper readme file and a license file
Signed-off-by: Bjoern Schiessle <bjoern@schiessle.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 45 insertions, 1 deletions
diff --git a/README.md b/README.md
index 52a299177..04a6db2c7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,45 @@
-This code is a proof of concept. Do not use it in production. \ No newline at end of file
+# Spreed.me App
+
+This is a video- and audio-conferencing app for Nextcloud
+
+## Contribution Guidelines
+
+Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.
+
+For more information please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md) to this repository.
+
+### Apply a license
+
+All contributions to this repository are considered to be licensed under
+the GNU AGPLv3 or any later version.
+
+Contributors to the Spreed.me app retain their copyright. Therefore we recommend
+to add following line to the header of a file, if you changed it substantially:
+
+```
+@copyright Copyright (c) <year>, <your name> (<your email address>)
+```
+
+For further information on how to add or update the license header correctly please have a look at [our licensing HowTo][applyalicense].
+
+### Sign your work
+
+We use the Developer Certificate of Origin (DCO) as a additional safeguard
+for the Nextcloud project. This is a well established and widely used
+mechanism to assure contributors have confirmed their right to license
+their contribution under the project's license.
+Please read [developer-certificate-of-origin][dcofile].
+If you can certify it, then just add a line to every git commit message:
+
+````
+ Signed-off-by: Random J Developer <random@developer.example.org>
+````
+
+Use your real name (sorry, no pseudonyms or anonymous contributions).
+If you set your `user.name` and `user.email` git configs, you can sign your
+commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
+like `git config --global alias.ci 'commit -s'`. Now you can commit with
+`git ci` and the commit will be signed.
+
+[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin
+[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md