README

   1
   2 Licensing
   3 ========================
   4
   5 Catalyst is copyrighted by the Gentoo Foundation, and is released under the
   6 terms of the GNU General Public License v.2.1. For more information, please
   7 consult COPYING.
   8
   9 Disclaimer
  10 ========================
  11
  12 The Gentoo Foundation extends no warranty or guarantee for catalyst. This
  13 software is provided to the public to comply with the Gentoo social contract
  14 and to assist other distributors and integrators of Gentoo and Gentoo-based
  15 solutions. Use at your own risk.
  16
  17 Requirements
  18 =======================
  19
  20 - Python 2.4 or greater (may still work with 2.3)
  21 - A portage snapshot (or portage tree to make your own)
  22 - A Gentoo generic stage3 tarball
  23 - shash for digest support
  24
  25 What is Catalyst?
  26 ========================
  27
  28 Catalyst is the Gentoo Linux project's release building tool. With catalyst,
  29 you are able to completely customize your Gentoo install by customizing
  30 the very tools that are used to install a system. Official Gentoo Linux release
  31 media is built with catalyst.
  32
  33 Catalyst is capable of:
  34
  35 - Building installation stages for every architecture supported by Gentoo
  36 - Building bootable LiveCDs for every architecture supported by Gentoo
  37 - Building GRP (Gentoo Reference Platform) sets for every architecture supported by Gentoo
  38 - Setting up a Tinderbox target for test building
  39 - Building netboot images
  40
  41 Configuring catalyst
  42 ========================
  43
  44 After emerging/installing catalyst, the first (and probably only) thing
  45 that you will have to do is edit /etc/catalyst/catalyst.conf to your liking.
  46
  47 Example catalyst.conf:
  48
  49 distdir="/usr/portage/distfiles"
  50 options="pkgcache kerncache"
  51 sharedir="/usr/lib/catalyst"
  52
  53 There are many more options that can be set, but those defaults are good
  54 for out of the box operation. For more documentation on what you can do
  55 with catalyst, please check the man page or the online documentation at
  56 http://www.gentoo.org/proj/en/releng/catalyst.