-# $Header: /var/cvsroot/gentoo/src/catalyst/README,v 1.17 2006/10/02 20:41:53 wolf31o2 Exp $
+# $Id$
Licensing
========================
-Catalyst is copyrighted by the Gentoo Foundation, and is released under the
-terms of the GNU General Public License v.2.1. For more information, please
-consult COPYING.
+Originally, Catalyst was copyrighted by the Gentoo Foundation, Inc. and was
+released under the terms of the GNU General Public License v.2.1. Since this
+is a fork of that project, all new code is no longer copyrighted to the Gentoo
+Foundation. Currently, copyright is held by the individual authors for their
+contributions. For more information, please consult COPYING.
Disclaimer
========================
-The Gentoo Foundation extends no warranty or guarantee for catalyst. This
-software is provided to the public to comply with the Gentoo social contract
-and to assist other distributors and integrators of Gentoo and Gentoo-based
-solutions. Use at your own risk.
+This software is covered by no warranty or guarantee of functionality. It is
+provided to the public for use in creating source-based distributions in a
+simple and reproducable manner. Use at your own risk.
Requirements
=======================
- Python 2.4 or greater (may still work with 2.3)
-- A portage snapshot (or portage tree to make your own)
-- A Gentoo generic stage3 tarball
+- An ebuild repository snapshot (or an ebuild tree to create one)
+- A generic stage3 tarball for your architecture
- shash for digest support
-What is Catalyst?
+What is catalyst?
========================
-Catalyst is the Gentoo Linux project's release building tool. With catalyst,
+Catalyst is a release building tool, used by Gentoo Linux. With catalyst,
you are able to completely customize your Gentoo install by customizing
the very tools that are used to install a system. Official Gentoo Linux release
media is built with catalyst.
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
+- Building installation stages
+- Building bootable LiveCDs
+- Building GRP (Gentoo Reference Platform) sets
- Setting up a Tinderbox target for test building
- Building netboot images
After emerging/installing catalyst, the first (and probably only) thing
that you will have to do is edit /etc/catalyst/catalyst.conf to your liking.
+If you are not using an ebuild for the installation, you should create a
+/etc/catalyst directory, and copy catalyst.conf and catalystrc from the
+distribution tarball's files directory.
+
Example catalyst.conf:
distdir="/usr/portage/distfiles"
projects / catalyst.git / blobdiff