]> sipb.mit.edu Git - ikiwiki.git/blobdiff - README.SIPB
Set Content-Style-Type.
[ikiwiki.git] / README.SIPB
index 29127fd04193dc83209b4e3ac77862b752138711..c88f1938712c5d8012dd5dca92994a6386b5cf26 100644 (file)
@@ -1,5 +1,6 @@
 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.
 
 
@@ -22,19 +23,34 @@ of rearchitecting and upstream cooperation.
 
 Keeping up to date:
 
+XXX: This is what we'd do in our original clone of upstream.
+  How do we do this now that we have our own internal repo to clone?
+
 This two-tiered setup means that you will need to rebase twice in order
 to propagate changes; possibly once if master == origin/master. Your
 commands will look like this:
 
-$ git checkout origin
-if master == remotes/origin/master:
-  $ git pull
-else
-  $ git fetch
-  $ git rebase origin/master
-fi
+$ git checkout master
+$ git pull --rebase
 $ git checkout sipb
 $ git rebase master
 
 TODO: Make a script that does this.
 
+
+Scripts:
+
+The source repository has a hook that automatically deploys changes when
+you push to it.  If bad things happen, however, there are two scripts of
+interest:
+
+~/bin/reinstall-ikiwiki
+    This script runs make and make install, reinstalling the source files to
+    make it live.
+
+~/bin/update-ikiwiki
+    This script recompiles the website from its source directory
+    ikiwiki/src into the live wiki directory web_scripts/wiki.
+
+Normally, these don't need to be run.
+