Add some documentation around XModule/XModuleDescriptor initialization.

2013-06-28 16:51:03 -04:00
parent 4a41ce804f
commit 7aa76bc663
2 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -152,6 +152,12 @@ otherwise noted.

 Please see ``LICENSE.txt`` for details.

+Documentation
+------------
+
+High-level documentation of the code is located in the `doc` subdirectory. Start
+with `overview.md` to get an introduction to the architecture of the system.
+
 How to Contribute
 -----------------