Add a README, spell matrix correctly.

9 years ago · 1388612c48
parent 5a0e40b984
commit 1388612c48
2 changed files with 10 additions and 0 deletions
--- a/scripts/README
+++ b/scripts/README
@ -0,0 +1,10 @@
+Requirements:
+ - docutils (for converting RST to HTML) 
+
+To generate the complete specification along with supporting documentation, run:
+    python gendoc.py
+
+The output of this will be inside the "gen" folder.
+
+Matrix.org only ("gen" folder has matrix.org tweaked pages):
+    ./matrix-org-gendoc.sh /includes/nav.html
--- a/scripts/matrix-org-gendoc.sh
+++ b/scripts/matrix-org-gendoc.sh