Added a preliminary README. (warning: untested)

Not enough space on my current machine to test this out ;).

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..8472537
--- /dev/null
+++ b/README
@@ -0,0 +1,75 @@
+Setting up Catalyst
+-------------------
+
+Create a Portage tree snapshot
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Create a snapshot of the current source tree
+  # catalyst -C target=snapshot version_stamp=20100323 storedir="$CATALYSTDIR"
+will create
+  $CATALYSTDIR/snapshots/portage-20100323.tar.bz2
+
+Get Stage3 tarballs
+~~~~~~~~~~~~~~~~~~~
+
+Stage3 tarballs are stored in
+  $GENTOO_MIRROR/releases/$ARCH/current-stage3/
+For example,
+  http://distfiles.gentoo.org/releases/x86/current-stage3/stage3-i486-20100216.tar.bz2
+Take a look at
+  http://www.gentoo.org/main/en/mirrors.xml
+to find a mirror near you.
+
+Grab the tarball (and put it where catalyst will find it)
+  # wget http://.../stage3-i486-20100216.tar.bz2
+  # cp stage3-i486-20100216.tar.bz2 CATALYSTDIR/builds/
+
+Tweak *.spec files
+~~~~~~~~~~~~~~~~~~
+
+You may need to adjust the
+  subarch, snapshot, and source_subpath
+fields of the mainfiles/*.spec to match your target host, snapshot,
+and stage3 tarball name respectively.
+
+
+Building
+--------
+
+Now that everything's setup, run catalyst
+  # rebuild-kernel.sh <imagename>
+Which will create
+  $REPOBIN/kernels-x86/
+and...?
+
+Finally, run
+  # recreate-iso.sh <arch>
+to create
+  $DESTDIR/systemrescuecd-$ARCH-$VERSION-$MYDATE.iso
+  $DESTDIR/systemrescuecd-$ARCH-$VERSION-$MYDATE.tar.bz2
+
+
+Notes
+-----
+
+Gentoo stages
+~~~~~~~~~~~~~
+
+You can't compile with just a big pile of source, because you need a
+compiled toolchain.  This is what Gentoo's stages take care of.  The
+"base system" contains the necessary build tools and supporting
+infrastructure to get things going.  The stages are:
+ 1: System must be bootstrapped and the base system must be compiled.
+ 2: Stage1 + bootstrapped.
+ 3: Stage2 + base system compiled.
+ 4: Stage3 + non-base packages.
+See
+  http://www.gentoo.org/doc/en/faq.xml#stage12
+for more information.
+
+See also
+~~~~~~~~
+
+http://www.gentoo-wiki.info/HOWTO_build_a_LiveCD
+http://www.gentoo-wiki.info/HOWTO_Small_Footprint_Gentoo_on_USB
+