diff --git a/cms/README.rst b/cms/README.rst new file mode 100644 index 0000000000..1749fa0a73 --- /dev/null +++ b/cms/README.rst @@ -0,0 +1,4 @@ +CMS (Content Management System) +------------------------------- + +This directory contains code relating to the course management portal for edX, also known as Studio. \ No newline at end of file diff --git a/common/README.rst b/common/README.rst new file mode 100644 index 0000000000..1d2ca3fe82 --- /dev/null +++ b/common/README.rst @@ -0,0 +1,4 @@ +common +------ + +This directory contains common code shared between LMS and CMS, such as Mako templates, CSS, and Coffescript. \ No newline at end of file diff --git a/lms/README.rst b/lms/README.rst new file mode 100644 index 0000000000..7bd0f8879c --- /dev/null +++ b/lms/README.rst @@ -0,0 +1,4 @@ +LMS (Learning Management System) +-------------------------------- + +This directory contains code relating to the student portal for edX. \ No newline at end of file diff --git a/openedx/README.rst b/openedx/README.rst new file mode 100644 index 0000000000..27ac137b4a --- /dev/null +++ b/openedx/README.rst @@ -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. \ No newline at end of file