README

   1 # $Id$
   2
   3 Licensing
   4 ========================
   5
   6 Originally, Catalyst was copyrighted by the Gentoo Foundation, Inc. and was
   7 released under the terms of the GNU General Public License v.2.1.  Since this
   8 is a fork of that project, all new code is no longer copyrighted to the Gentoo
   9 Foundation.  Currently, copyright is held by the individual authors for their
  10 contributions.  For more information, please consult COPYING.
  11
  12 Disclaimer
  13 ========================
  14
  15 This software is covered by no warranty or guarantee of functionality.  It is
  16 provided to the public for use in creating source-based distributions in a
  17 simple and reproducable manner.  Use at your own risk.
  18
  19 Requirements
  20 =======================
  21
  22 - Python 2.4 or greater (may still work with 2.3)
  23 - An ebuild repository snapshot (or an ebuild tree to create one)
  24 - A generic stage3 tarball for your architecture
  25 - shash for digest support
  26
  27 What is catalyst?
  28 ========================
  29
  30 Catalyst is a release building tool, used by Gentoo Linux. With catalyst,
  31 you are able to completely customize your Gentoo install by customizing
  32 the very tools that are used to install a system. Official Gentoo Linux release
  33 media is built with catalyst.
  34
  35 Catalyst is capable of:
  36
  37 - Building installation stages
  38 - Building bootable LiveCDs
  39 - Building GRP (Gentoo Reference Platform) sets
  40 - Setting up a Tinderbox target for test building
  41 - Building netboot images
  42
  43 Configuring catalyst
  44 ========================
  45
  46 After emerging/installing catalyst, the first (and probably only) thing
  47 that you will have to do is edit /etc/catalyst/catalyst.conf to your liking.
  48
  49 If you are not using an ebuild for the installation, you should create a
  50 /etc/catalyst directory, and copy catalyst.conf and catalystrc from the
  51 distribution tarball's files directory.
  52
  53 Example catalyst.conf:
  54
  55 distdir="/usr/portage/distfiles"
  56 options="pkgcache kerncache"
  57 sharedir="/usr/lib/catalyst"
  58
  59 There are many more options that can be set, but those defaults are good
  60 for out of the box operation. For more documentation on what you can do
  61 with catalyst, please check the man page or the online documentation at
  62 http://www.gentoo.org/proj/en/releng/catalyst.