From a45cd1317f9b10cf80a46a7a41c9a82fceb254ff Mon Sep 17 00:00:00 2001 From: Clinton Blackburn Date: Fri, 20 Jun 2014 14:59:36 -0400 Subject: [PATCH] Updated README and AUTHORS Change-Id: I92ea1585f8ff16aee52c54e8267850967e983b76 --- AUTHORS | 3 +++ CONTRIBUTING.md | 3 +++ README.md | 27 ++++++++++++++++++++++++--- 3 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/AUTHORS b/AUTHORS index e69de29bb..c6dcc0854 100644 --- a/AUTHORS +++ b/AUTHORS @@ -0,0 +1,3 @@ +Clinton Blackburn +Dennis Jen +Carlos Andrés Rocha diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..65cb6e197 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +Contributions are very welcome. + +Please read [How To Contribute](https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst) for details. diff --git a/README.md b/README.md index 45e14432a..8d6ff9a67 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -analytics-dashboard -=================== +Part of [edX code](http://code.edx.org/) +edX Analytics Dashboard +======================= Dashboard to display course analytics to course teams Getting Started --------------- - 1. Get the code (e.g. clone the repository). 2. Install the Python requirements: @@ -19,7 +19,28 @@ Getting Started ./manage.py runserver +License +------- +The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. + +Please see `LICENSE.txt` for details. + +How To Contribute +----------------- +Contributions are very welcome. + +Please read [How To Contribute](https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst) for details. + Testing ------- $ ./manage.py test + +Reporting Security Issues +------------------------- +Please do not report security issues in public. Please email security@edx.org. + + +Mailing List and IRC Channel +---------------------------- +You can discuss this code on the [edx-code Google Group](https://groups.google.com/forum/#!forum/edx-code) or in the `edx-code` IRC channel on Freenode.