                                                                -*- outline -*-
$Progeny: README,v 1.14 2002/04/12 19:17:23 branden Exp $

All documentation has moved to the doc dir.  This is just a short description
of how things are laid out.  The intended audience is those who want to hack
on PGI itself.  People who just want to use a PGI-based installer, or use
pgi-build to create one, should reference the PGI manuals instead: _Using the
PGI Debian Installer_, and _Creating Debian Installers with PGI_.

If you are reading this file from a Debian binary package, the locations
referred to are relative to /usr/share/pgi.

* /
        There are a few files at the top level.

**      busybox.h
                This is our Config.h for busybox (both stage 0 and stage 1,
                thanks to pre-processor conditionals).

**      busybox.mkll, busybox.sh
                These are part of the BusyBox build system we have to replace
                due to its lame limitations.  The former makes the symlinks to
                the busybox program and the latter is some kind of
                compiler-wrapper script.

**      pgi-build
                This is the command that builds PGI-based installers.

**      options
                These are parameters that influence pgi-build's behavior (and
                thus the behavior of the PGI installer itself).

* stage0
        Builds the stage 0 initrd.  Stage 0 should be as tiny as possible; its
        sole purpose in life is finding a live filesystem so it can start
        stage 1.

* stage1
        Builds the stage 1 live filesystem, including various installation
        helper programs.  The actual drivers of the installation process are
        POSIX shell scripts, which call out to Python programs in places (such
        as installer-druid and setup-base-text).

* debootstrap
        PGI has to have its own forked version of debootstrap because version
        0.1.17 doesn't work for us.  Hopefully after Debian 3.0 releases, this
        can be dropped.

* python
        Contains the pgi.* Python modules, where we try to hide as
        much of the actual work as possible so both text mode and GUI
        mode can take advantage of it.

* archive
        This is responsible for building a split-up Debian package archive for
        placement onto ISO images.  Currently it's a hacked-up version of
        debian-cd.  Eventually, we'd like to replace it with calls to a
        brand-new, generic archive-splitting tool.

* images
        This contians arch-specific directories.  Each one contains whatever
        is necessary to produce PGI images that will work for a given machine
        architecture.

* tools
        Various tools used as part of the PGI *build* process.  If a
        tool is part of the installer itself, it should go into one of
        the above sub-directories.

* user-configlet
        This needs to die, or at least be moved into examples/configlets.

* examples
        Examples of flavors that set up a second stage.

* other directories
        The other directories aren't directly related to PGI.  doctools
        contains Progeny's documentation building tools, doc contains the
        actual documentation, and debian contains the Debian packaging files.

vim:set et tw=78:
