added READMEs for top level directories

This commit is contained in:
Mayank Jain
2015-03-31 16:31:05 +02:00
parent 10d58d3644
commit cf7777a474
4 changed files with 20 additions and 0 deletions

4
cms/README.rst Normal file
View File

@@ -0,0 +1,4 @@
CMS (Content Management System)
-------------------------------
This directory contains code relating to the course management portal for edX, also known as Studio.

4
common/README.rst Normal file
View File

@@ -0,0 +1,4 @@
common
------
This directory contains common code shared between LMS and CMS, such as Mako templates, CSS, and Coffescript.

4
lms/README.rst Normal file
View File

@@ -0,0 +1,4 @@
LMS (Learning Management System)
--------------------------------
This directory contains code relating to the student portal for edX.

8
openedx/README.rst Normal file
View File

@@ -0,0 +1,8 @@
OpenEdx
-------
This is the root package for Open edX.
The intent is that all importable code from Open edX will eventually live here, including the code in the lms, cms, and common directories.
Note: for now the code is not structured like this, and hence legacy code will continue to live in a number of different packages.
All new code should be created in this package, and the legacy code will be moved here gradually.