1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a532187
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+# album examples for ikiwiki
+
+This repository contains a number of examples for the ikiwiki album plugin.
+
+The album plugin is not currently included in ikiwiki. To build the examples,
+you can use the included Makefile to clone the album branch from
+git://git.cbaines.net/ikiwiki, which includes the album plugin.
+
+Alternatively, you can follow the instructions on the Ikiwiki website to
+install the album plugin.
+
+## Examples
+
+### Basic
+
+Contains 5 ikiwiki logos, taken from the ikiwiki website.
+
+Each of the setup files builds the wiki with a different theme.
+
+## Build Details
+
+The included makefile will download ikiwiki, build it, and then use it to
+build all of the examples.
+
+The examples will end up in dest.