# Copyright 1999-2004 Gentoo Technologies, Inc.
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo/src/catalyst/README,v 1.8 2004/02/25 19:30:19 pvdabeel Exp $

Licensing
========================

Catalyst is copyrighted by Gentoo Technolgies, Inc, and released
under the terms of the GNU General Public License v.2.0 or later. For more
information, please consult COPYING.

Disclaimer
========================

Gentoo Linux extends no warranty or guarantee for catalyst. Use at
your own risk.

Requirements
=======================

-Python
-Gentoo Linux Portage
-GNU gcc, glibc, binutils

What is Catalyst?
========================

Catalyst is the Gentoo Linux project's release building tool. With catalyst,
you are able to completely customize your Gentoo install by customizing
the very tools you install your system with.

Catalyst is capable of:

-Building installation stages for every architecture supported by Gentoo.
-Building bootable LiveCDs for every architecture supported by Gentoo.
-Building GRP (Gentoo Reference Platform) sets for every architecture supported by Gentoo.
-Setting up a Tinderbox target for test building.

Configuring catalyst
========================

After emerging catalyst, the first thing (and probably only thing)
that you will have to do is edit /etc/catalyst.conf to your liking.

Example catalyst.conf:

distdir="/usr/portage/distfiles"
options="ccache pkgcache"
sharedir="/usr/share/catalyst/modules"

There are many more options that can be set, but those defaults are good
for out of the box operation. For more documentation on what you can do
with catalyst, please check the man page or the online documentation at
<http://www.gentoo.org/proj/en/releng/catalyst>.