README

   1 # Copyright 1999-2005 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3 # $Header: /var/cvsroot/gentoo/src/catalyst/README,v 1.15 2005/12/21 16:56:01 wolf31o2 Exp $
   4
   5 Licensing
   6 ========================
   7
   8 Catalyst is copyrighted by the Gentoo Foundation, and released
   9 under the terms of the GNU General Public License v.2.0 or later. For more
  10 information, please consult COPYING.
  11
  12 Disclaimer
  13 ========================
  14
  15 Gentoo Linux extends no warranty or guarantee for catalyst. Use at
  16 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 seed stage 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 you install your system with.
  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 catalyst, the first thing (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>.