Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added docs README, made little fixes.

  • Loading branch information...
commit 19d85e870f9a636583c59865c705951c14bb0b11 1 parent eaade7f
David LaBissoniere labisso authored
18 docs/README.txt
View
@@ -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.
+
+Directory structure:
+
+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).
1  docs/html/.gitignore
View
@@ -0,0 +1 @@
+*
2  docs/scripts/build-and-serve-locally.sh
View
@@ -29,7 +29,7 @@ fi
(cd $THISDIR ; $MACRO_EXE $MACRO_PROGRAM)
echo ""
-OUTPUT_DIR=$THISDIR/../m4-processed
+OUTPUT_DIR=$THISDIR/../html
OUTPUT_DIR2=`cd $OUTPUT_DIR; pwd`
echo "Website built @ $OUTPUT_DIR2"
echo ""
Please sign in to comment.
Something went wrong with that request. Please try again.