Add a README.md to give clearer guidance to github users. 71/17871/9
authorMats Wichmann <mats@linux.com>
Thu, 16 Mar 2017 15:00:34 +0000 (09:00 -0600)
committerDave Thaler <dthaler@microsoft.com>
Tue, 4 Apr 2017 18:16:43 +0000 (18:16 +0000)
The information just points to various resources, may be
useful to others as well.

Revised version to reflect review comments.

Change-Id: I1ba4f2b017bf8b60a9c382260131d23c734001b2
Signed-off-by: Mats Wichmann <mats@linux.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/17871
Reviewed-by: Phil Coval <philippe.coval@osg.samsung.com>
Tested-by: jenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: Dave Thaler <dthaler@microsoft.com>
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..1f50c8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# The IoTivity project
+
+IoTivity is an open source software framework enabling seamless
+device-to-device connectivity to address the emerging needs of the
+Internet of Things.
+
+The project is described on https://iotivity.org and
+https://wiki.iotivity.org.
+
+The IoTivity project is licensed under the 
+[Apache 2.0 license](LICENSE.md).
+
+Components used by the project are described in 
+[NOTICE.md](NOTICE.md).
+
+To become a contributor, start by reading
+https://www.iotivity.org/get-involved which describes project governance,
+contribution guidelines and obtaining an account.
+
+The master git location for IoTivity projects is gated by an instance of
+the [Gerrit reviewing system](https://gerrit.iotivity.org),
+such that pushing a change in git is intercepted by Gerrit
+and presented as a review page.  The process of setting up
+and using Gerrit for IoTivity is documented in a pair of
+wiki pages:
+  
+* https://wiki.iotivity.org/how_to_use_gerrit
+* https://wiki.iotivity.org/submitting_to_gerrit 
+
+The issue tracker for the project lives at https://jira.iotivity.org.
+
+**Note**: if you are reading this file from a source other than the
+[official repository](https://gerrit.iotivity.org/gerrit/gitweb?p=iotivity.git;a=summary),
+for example on the Github mirror,
+please be aware that work happens relative to the official location. For
+example, github pull requests and issue filings are very unlikely to be
+acted upon, or even seen, by project participants.
+