Add documentation.

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..fb0bc89
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+xodist - Debian image builder for OLPC XO
+
+See *.packages for other image flavours, and change "kde" below to the
+flavour.  See README.approx before starting if you would like to cache
+the packages downloaded.
+
+How to use xodist to generate a Debian KDE image:
+
+1.  build the root filesystem,
+
+       sudo ./initchroot.sh --package-list kde.packages kde.root
+
+2.  make the JFFS2 filesystem,
+
+       sudo ./mkjffs2.sh kde.root kde.img
+
+3.  copy the kde.img and kde.crc files to a thumb drive,
+
+       cp kde.img kde.crc /mnt/
+
+4.  boot an XO into OFW, then type:
+
+        copy-nand u:\kde.img
+
+Warning: this erases everything on the XO.

diff --git a/README.approx b/README.approx
new file mode 100644 (file)
index 0000000..f93bb4a
--- /dev/null
+++ b/README.approx
@@ -0,0 +1,25 @@
+Problem: every time you use initchroot.sh the hundreds of megabytes of
+packages are downloaded again.
+
+Solution: set up the approx package to cache these packages.
+
+1.  install the approx package,
+
+        % sudo aptitude install approx
+
+2.  add the following lines to /etc/approx/approx.conf,
+
+debian          http://http.us.debian.org/debian
+security        http://security.debian.org/
+
+3.  restart approx,
+
+       % sudo /etc/init.d/approx restart
+
+4.  during the creation of the root filesystem described in README,
+add the --mirror option, like this:
+
+        sudo ./initchroot.sh \
+            --package-list kde.packages \
+            --mirror http://localhost:9999/debian kde.root
+