From: Carl Worth <cworth@cworth.org>
Date: Tue, 12 Jun 2007 23:10:03 +0000 (-0700)
Subject: Add a simple README
X-Git-Url: https://git.cworth.org/git?p=ikiwiki-bootstrap;a=commitdiff_plain;h=b188add49367232448e5349691fd1447eb0ded77

Add a simple README
---

diff --git a/README b/README
new file mode 100644
index 0000000..c2589e0
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+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:
+
+	http://ikiwiki.info/setup/
+
+Features
+========
+Here are some of the key features of what I've got setup:
+
+1. Self-contained.
+
+	The ikiwiki configuration file, the templates, and source
+	files are all together in one repository.
+
+2. Minimal
+
+	The default ikiwiki setup instructions would pull in a bunch
+	of "stock" wiki pages and some underlay content. This setup
+	saves you the hassle of having to prune any of that out.
+
+3. Pre-configured for git
+
+	Most of the git-specific settings you need are already setup
+	in ikiwiki.setup.
+
+Usage
+=====
+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:
+
+	mkdir -p $gitrepo
+	cd $gitrepo
+	GIT_DIR=. git init-db
+	git clone $gitrepo ikiwiki-checkout
+
+Finally, push this repository out to $gitrepo, then start adding
+content in files under src.
+
+Let me know if you have any problems or questions,
+
+Carl Worth <cworth@cworth.org>