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.13 2005/04/20 20:45:47 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.3 or greater
  22 - A portage snapshot
  23 - A Gentoo seed stage tarball
  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 you install your system with.
  31
  32 Catalyst is capable of:
  33
  34 - Building installation stages for every architecture supported by Gentoo.
  35 - Building bootable LiveCDs for every architecture supported by Gentoo.
  36 - Building GRP (Gentoo Reference Platform) sets for every architecture supported by Gentoo.
  37 - Setting up a Tinderbox target for test building.
  38 - Building netboot images.
  39
  40 Configuring catalyst
  41 ========================
  42
  43 After emerging catalyst, the first thing (and probably only thing)
  44 that you will have to do is edit /etc/catalyst/catalyst.conf to your liking.
  45
  46 Example catalyst.conf:
  47
  48 distdir="/usr/portage/distfiles"
  49 options="pkgcache kerncache"
  50 sharedir="/usr/lib/catalyst"
  51
  52 There are many more options that can be set, but those defaults are good
  53 for out of the box operation. For more documentation on what you can do
  54 with catalyst, please check the man page or the online documentation at
  55 <http://www.gentoo.org/proj/en/releng/catalyst>.