From: Edward Z. Yang Date: Mon, 12 Jan 2009 00:27:40 +0000 (-0500) Subject: Add documentation for bin scripts. X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/commitdiff_plain/dabbf9e75ba7cde0b81c528afde19c994d1a1f89 Add documentation for bin scripts. Signed-off-by: Edward Z. Yang --- diff --git a/README.SIPB b/README.SIPB index 29127fd04..6fe9c87f8 100644 --- a/README.SIPB +++ b/README.SIPB @@ -1,8 +1,28 @@ 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. +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