Please sign in to comment.
Added docs README, made little fixes.
- Loading branch information...
Showing with 20 additions and 1 deletion.
|@@ -0,0 +1,18 @@|
|+Docs are in a state of transition right now. We are writing docs in HTML with|
|+the aid of some M4 macros. Hopefully this will soon be replaced with|
|+something like Sphinx.|
|+src/ - source html files containing M4 references|
|+html/ - directory for html output. contents are gitignored|
|+m4/ - macro definition files|
|+scripts/ - shell scripts to do useful things with docs|
|+How to do stuff:|
|+To locally view docs, run build-and-serve-locally.sh and then open your web|
|+browser to the URL printed out.|
|+To push docs to the live site, run push_to_mcs_web.sh. You must be on an MCS|
|+shell (with access to /mcs/ filesystem).|
|@@ -0,0 +1 @@|