]> git.cworth.org Git - ikiwiki-bootstrap/commitdiff
Add more details to README about setting up the post-update hook
authorCarl Worth <cworth@cworth.org>
Fri, 15 Jun 2007 17:32:07 +0000 (10:32 -0700)
committerCarl Worth <cworth@cworth.org>
Fri, 15 Jun 2007 17:32:07 +0000 (10:32 -0700)
README

diff --git a/README b/README
index e6658aa8600300ef757ec8c66a0615efa183a5a2..fe63d146efe7b1d0a02866e437e9cf05f3e5f062 100644 (file)
--- a/README
+++ b/README
@@ -43,13 +43,26 @@ inside of it that ikiwiki will use:
        mkdir -p $gitrepo
        cd $gitrepo
        GIT_DIR=. git init-db
+
+Then, push the contents of this repository out to $gitrepo and
+continue with the following commands (still with $gitrepo as the
+current working directory):
+
        git clone $gitrepo ikiwiki-checkout
+       cd ikiwiki-checkout
+       ikiwiki --setup ikiwiki.setup
+
+And finally, edit $gitrepo/hooks/post-update to call the new
+$gitrepo/hooks/ikiwiki-post-update program and also don't forget to
+actually enable the hook with:
+
+       chmod a+x $gitrepo/hooks/post-update .
 
-Finally, push this repository out to $gitrepo. Then edit
-$gitrepo/hooks/post-update to call the now-generated
-ikiwiki-post-update wrapper, (and don't forget to make chmod
-post-update to be executable). And finally, start adding content in
-files under src, using "git push" to publish.
+Now, you're finally ready to go, and you should be able to just start
+adding content under the src directory and use "git push" to publish
+them. To preview things locally, just run "ikiwiki --setup
+ikiwiki.setup", (and ensure the destination paths exist on the local
+machine as well).
 
 Let me know if you have any problems or questions,