Show title and breadcrumbs together
[ikiwiki.git] / README.SIPB
index 29127fd04193dc83209b4e3ac77862b752138711..084a29251886ae35a3ffbd676f2d0f1cb6af2469 100644 (file)
@@ -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 from its source directory
+    ikiwiki/src into the live wiki directory web_scripts/wiki.
+    It should be needed only if you do something odd; if you push
+    to the master repo at wiki.git, the post-update hook will do the
+    same thing as this.
+
 Setup:
 
 There are three branches of interest: remotes/origin/master, master