From 1388612c4877d0b0b33e148edd9cd86b5130a47c Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Thu, 19 Feb 2015 16:53:54 +0000 Subject: [PATCH] Add a README, spell matrix correctly. --- scripts/README | 10 ++++++++++ scripts/{matrx-org-gendoc.sh => matrix-org-gendoc.sh} | 0 2 files changed, 10 insertions(+) create mode 100644 scripts/README rename scripts/{matrx-org-gendoc.sh => matrix-org-gendoc.sh} (100%) diff --git a/scripts/README b/scripts/README new file mode 100644 index 00000000..b9285412 --- /dev/null +++ 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 diff --git a/scripts/matrx-org-gendoc.sh b/scripts/matrix-org-gendoc.sh similarity index 100% rename from scripts/matrx-org-gendoc.sh rename to scripts/matrix-org-gendoc.sh