README.md 2.2 KB
Newer Older
1 2 3
This is the main edX platform which consists of LMS and Studio.

See [code.edx.org](http://code.edx.org/) for other parts of the edX code base.
4

5 6
Installation
------------
7

8
Please refer to the following wiki pages in our [configuration repo](https://github.com/edx/configuration) to install edX:
9

10
* [edX Developer Stack](https://github.com/edx/configuration/wiki/edX-Developer-Stack)
11
<br/>These instructions are for developers who want to contribute or make changes to the edX source code.
12
* [edX Production Stack](https://github.com/edx/configuration/wiki/edX-Production-Stack)
13
<br/>Using Vagrant/Virtualbox this will setup all edX services on a single server in a production like configuration.
14
* [edX Ubuntu 12.04 installation](https://github.com/edx/configuration/wiki/edX-Ubuntu-12.04-Installation)
15
<br/>This will install edX on an existing Ubuntu 12.04 server.
16

17

18 19 20 21
License
-------

The code in this repository is licensed under version 3 of the AGPL unless
22 23 24
otherwise noted. Please see the
[`LICENSE`](https://github.com/edx/edx-platform/blob/master/LICENSE) file
for details.
25

26 27 28
Documentation
------------

29 30 31 32
High-level documentation of the code is located in the `docs` subdirectory.
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/).
33

34 35 36
How to Contribute
-----------------

37 38 39 40 41 42
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)
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.
43 44 45

Reporting Security Issues
-------------------------
46

47
Please do not report security issues in public. Please email security@edx.org
48

49 50
Mailing List and IRC Channel
----------------------------
51

52
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).