From: Carl Worth <cworth@cworth.org>
Date: Fri, 15 Jun 2007 18:09:30 +0000 (-0700)
Subject: Add some clarifications thanks to feedback from Richard.
X-Git-Url: https://git.cworth.org/git?p=ikiwiki-bootstrap;a=commitdiff_plain;h=b0afdc29c02147822a454304750938b40f44a88f

Add some clarifications thanks to feedback from Richard.
---

diff --git a/README b/README
index fe63d14..27d04a5 100644
--- a/README
+++ b/README
@@ -1,14 +1,18 @@
 This is a simple set of files for bootstrapping a git-backed instance
 of ikiwiki.
 
-I put this together to make it easier to get started with ikiwiki than
-following the standad instructions:
+I put this together to make it easier for people who are already
+comfortable with git to start using ikiwiki with git. If you're not
+already comfortable with git, then you're probably much better off
+learning to use ikiwiki from its standard instructions:
 
 	http://ikiwiki.info/setup/
 
 Features
 ========
-Here are some of the key features of what I've got setup:
+Here are some of the key features of what I've got setup, (and that
+are different than following the standard instruction for integrating
+ikiwiki with git).
 
 1. Self-contained.
 
@@ -33,12 +37,12 @@ Here are some of the key features of what I've got setup:
 
 Usage
 =====
-To start choose where the bare git repository will exist on your web
+To start, choose where the bare git repository will exist on your web
 server and where you'd like the HTML results to be published to. Edit
 ikiwiki.setup and fill these in for gitrepo and destdir.
 
-Next, follow these steps to setup gitrepo along with a nested checkout
-inside of it that ikiwiki will use:
+Then use the following commands to setup everything you'll need on the
+server:
 
 	mkdir -p $gitrepo
 	cd $gitrepo
@@ -52,6 +56,13 @@ current working directory):
 	cd ikiwiki-checkout
 	ikiwiki --setup ikiwiki.setup
 
+[And yes, if you're paying attention there, we just cloned from the
+bare repository into a directory that is also inside that same
+repository. I found this a neat place to hide away the
+clone-with-working-tree that ikiwiki needs to edit but that you
+shouldn't touch. If you think this is too creepy, you could put it
+anywhere else, and configure ikiwiki.setup to point to it there.]
+
 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: