Commit 2c1eb47f by David Baumgold

Merge pull request #2665 from edx/db/update-readme-for-contributing

Update and linkify our README file
parents e4b6fe2c 99888392
...@@ -7,11 +7,11 @@ Installation ...@@ -7,11 +7,11 @@ Installation
Please refer to the following wiki pages in our [configuration repo](https://github.com/edx/configuration) to install edX: Please refer to the following wiki pages in our [configuration repo](https://github.com/edx/configuration) to install edX:
* [edX Developer Stack](https://github.com/edx/configuration/wiki/edX-Developer-Stack) * [edX Developer Stack](https://github.com/edx/configuration/wiki/edX-Developer-Stack)
<br/>These instructions are for developers who want to contribute or make changes to the edX source code. <br/>These instructions are for developers who want to contribute or make changes to the edX source code.
* [edX Production Stack](https://github.com/edx/configuration/wiki/edX-Production-Stack) * [edX Production Stack](https://github.com/edx/configuration/wiki/edX-Production-Stack)
<br/>Using Vagrant/Virtualbox this will setup all edX services on a single server in a production like configuration. <br/>Using Vagrant/Virtualbox this will setup all edX services on a single server in a production like configuration.
* [edX Ubuntu 12.04 installation](https://github.com/edx/configuration/wiki/edX-Ubuntu-12.04-Installation) * [edX Ubuntu 12.04 installation](https://github.com/edx/configuration/wiki/edX-Ubuntu-12.04-Installation)
<br/>This will install edX on an existing Ubuntu 12.04 server. <br/>This will install edX on an existing Ubuntu 12.04 server.
...@@ -19,22 +19,27 @@ License ...@@ -19,22 +19,27 @@ License
------- -------
The code in this repository is licensed under version 3 of the AGPL unless The code in this repository is licensed under version 3 of the AGPL unless
otherwise noted. otherwise noted. Please see the
[`LICENSE`](https://github.com/edx/edx-platform/blob/master/LICENSE) file
Please see ``LICENSE.txt`` for details. for details.
Documentation Documentation
------------ ------------
High-level documentation of the code is located in the `doc` subdirectory. Start High-level documentation of the code is located in the `docs` subdirectory.
with `overview.md` to get an introduction to the architecture of the system. Most (although not all) of our documentation is built using
[Sphinx](http://sphinx-doc.org/): you can [view the built documentation on
ReadTheDocs](http://edx.readthedocs.org/).
How to Contribute How to Contribute
----------------- -----------------
Contributions are very welcome. Contributions are very welcome, but for legal reasons, you must submit a signed
[individual contributor's agreement](http://code.edx.org/individual-contributor-agreement.pdf)
Please read [How To Contribute](https://github.com/edx/edx-platform/wiki/How-To-Contribute) for details. before we can accept your contribution. See our
[CONTRIBUTING](https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst)
file for more information -- it also contains guidelines for how to maintain
high code quality, which will make your contribution more likely to be accepted.
Reporting Security Issues Reporting Security Issues
------------------------- -------------------------
...@@ -44,5 +49,4 @@ Please do not report security issues in public. Please email security@edx.org ...@@ -44,5 +49,4 @@ Please do not report security issues in public. Please email security@edx.org
Mailing List and IRC Channel 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 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](http://webchat.freenode.net/?channels=edx-code).
`edx-code` IRC channel on Freenode.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment