X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/dabbf9e75ba7cde0b81c528afde19c994d1a1f89..cf079f627e370ee823f07604a9a42dccc59f2afd:/README.SIPB

diff --git a/README.SIPB b/README.SIPB
index 6fe9c87f8..c88f19387 100644
--- a/README.SIPB
+++ b/README.SIPB
@@ -4,25 +4,6 @@ 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
@@ -42,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.
+