README.approx: update documentation

[xodist] / README

diff --git a/README b/README
index fb0bc89da5ce7ad3af52d5570c7a34d40882d209..aaa04610bd6057dd049b1b2705ae8acf165e7f0e 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,46 @@
 xodist - Debian image builder for OLPC XO
 
 xodist - Debian image builder for OLPC XO
 

-See *.packages for other image flavours, and change "kde" below to the
+Why is this needed?  Because the OLPC XO has exceptional and flexible
+firmware support unlike an ordinary PC.  The usual Debian boot CDs do
+not work, yet.  xodist builds a Debian system image in the format
+required by the firmware.
+
+See configs/* 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.
 
 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:
+How to use xodist to generate a Debian KDE image for an OLPC XO:

 
 1.  build the root filesystem,
 
 
 1.  build the root filesystem,
 

-       sudo ./initchroot.sh --package-list kde.packages kde.root
+       sudo ./mkchroot.sh --config-type debxo-kde debxo-kde.root

 
 2.  make the JFFS2 filesystem,
 
 
 2.  make the JFFS2 filesystem,
 

-       sudo ./mkjffs2.sh kde.root kde.img
+       sudo ./mkjffs2.sh --config-type debxo-kde debxo-kde.root debxo-kde.img
+
+3.  copy the files to a thumb drive,
+
+       sudo ./mkbootable.sh --output /mnt debxo-kde
+
+4.  ensure the XO is unlocked, by obtaining a Developer Key, and using
+the OpenFirmware command,
+
+       disable-security
+
+5.  shut down the XO,

 
 

-3.  copy the kde.img and kde.crc files to a thumb drive,
+6.  insert the thumb drive,

 
 

-       cp kde.img kde.crc /mnt/
+7.  power up, answer the prompt, and the image will be copied to the
+NAND flash, and then booted,

 
 

-4.  boot an XO into OFW, then type:
+Warning: this erases everything on the XO, including any Developer
+Key, but if you have followed step 4 above that should not matter so
+much.

 
 

-        copy-nand u:\kde.img
+8.  remove the thumb drive before the next reboot or power up.

 
 

-Warning: this erases everything on the XO.
+Note: Firmware Q2E20 or newer is required. The jffs2 images are for
+installation on NAND (the onboard flash), the ext3 images are only for
+usbsticks and sd-cards.