README

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