# HG changeset patch
# User Bernhard Herzog <bh@intevation.de>
# Date 1176406994 -7200
# Node ID 2eefd12526ffcd5d8bf8a42cbdd430b04bc6c72c
# Parent  4b537aadc5ce335b1157343c3229307fa4fb51c9
flesh out the REAME file some more

diff -r 4b537aadc5ce -r 2eefd12526ff README
--- a/README	Thu Apr 12 21:01:42 2007 +0200
+++ b/README	Thu Apr 12 21:43:14 2007 +0200
@@ -68,7 +68,27 @@
 The file demo.cfg contains example configuration that contains most of
 what is needed to package KDEPIM and kde-i18n from the KDEPIM enterprise
 branch.  Copy this file to treepkg.cfg and adapt it to your needs.  The
-comments in the file should provide enough hints to get you started.
+comments in the file should provide most of the hints to get you
+started.  Some more information is in the "Configuring a packager"
+section below.
+
+
+Configuring a packager
+~~~~~~~~~~~~~~~~~~~~~~
+
+The configuration file contains on section for each packager.  The
+section name starts with a "pkg_" prefix.  The possible options are
+described in demo.cfg.  However there are some things that need to be
+set up outside of the config file.
+
+Each packager has a base directory (the base_dir option in the
+corresponding pkg_-section).  One thing needed by a packager is the
+contents of the debian subdirectory of the debian source package.  When
+creating the source package, the packager simply copies the subdirectory
+"debian" of the base_dir into the directory making up the source tree.
+How the debian directory is created and maintained is up to you.
+Usually it's a good idea to start with the debian subdirectory an
+existing debian package for the software.
 
 
 Configure pbuilder
@@ -122,3 +142,24 @@
 the file describe the options.  Afterwards, run the script with
 
   ./publishstaticweb.py
+
+
+Running the Tree Packager
+-------------------------
+
+After configuration, run the tree packager with
+
+  ./runtreepkg.py  [options] [packager...]
+
+For each packager listed on the command line -- or all configured
+packagers if none are given -- the tree packager checks our or updates
+the sources and builds binary packages if the new revision hasn't been
+packaged yet.
+
+If the option --once has been given, the tree packager exits after it
+has checked each packager once.  Without it, the check is done
+repeatedly.  The interval between two checks can be set in the config
+file.
+
+Call runtreepkg.py with the --help option to see a list of the available
+options.