Add documentation for bin scripts.
authorEdward Z. Yang <edwardzyang@thewritingpot.com>
Mon, 12 Jan 2009 00:27:40 +0000 (19:27 -0500)
committerEdward Z. Yang <edwardzyang@thewritingpot.com>
Mon, 12 Jan 2009 04:24:26 +0000 (23:24 -0500)
Signed-off-by: Edward Z. Yang <edwardzyang@thewritingpot.com>
README.SIPB

index 29127fd04193dc83209b4e3ac77862b752138711..6fe9c87f86f75dcd5f76db7c6de8d611f9bbbaf7 100644 (file)
@@ -1,8 +1,28 @@
 README for SIPB maintainers
 
 README for SIPB maintainers
 
+Basic instructions on scripts of interest. Also,
 How this repository is set up, and how to keep IkiWiki up to date.
 
 
 How this repository is set up, and how to keep IkiWiki up to date.
 
 
+Overview:
+
+IkiWiki is a compiler based wiki, as such the files you should be editing
+are not the live files, and you will need to run a script in order to make
+your changes live.  These scripts must be run as sipb-www@scripts.mit.edu,
+do not attempt to run them locally. The scripts are as follows:
+
+~/bin/reinstall-ikiwiki
+    This script reinstalls the source files (i.e. this directory) and must
+    be run if you edit source files or templates or anything else in this
+    directory.
+
+~/bin/update-ikiwiki
+    This script recompiles the website and should be run if you make any
+    modification to pages.
+        XXX: Eventually, pushing to the Wiki repository will automatically
+        run updates; until then, you'll need to run update-ikiwiki then
+        as well.
+
 Setup:
 
 There are three branches of interest: remotes/origin/master, master
 Setup:
 
 There are three branches of interest: remotes/origin/master, master