added READMEs for top level directories

cahrens · Mar 31, 2015 · cf7777a · cf7777a
1 parent 10d58d3
commit cf7777a
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/cms/README.rst 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.
diff --git a/common/README.rst 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.
diff --git a/lms/README.rst b/lms/README.rst
@@ -0,0 +1,4 @@
+LMS (Learning Management System)
+--------------------------------
+
+This directory contains code relating to the student portal for edX.
diff --git a/openedx/README.rst 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.