README

   1 Welcome to the SCons development tree.  Here's a brief guide (not
   2 guaranteed to be up-to-date) to what you'll find herein:
   3
   4 admin/
   5         Documentation of SCons administrative procedures.  Maybe
   6         other administrative stuff in the future.
   7
   8 build/
   9         This doesn't exist if you're looking at a vanilla source tree.
  10         This is generated as part of our build process, and it's where,
  11         believe it or not, we *build* everything.
  12
  13 Construct
  14         The "Makefile" for the SCons distribution.  Yes, we're using
  15         Cons to build its improved stepchild.  (Of course, this will
  16         change to an SConstruct file as soon as we have SCons to the
  17         point where it can handle the functionality we need...)
  18
  19 config
  20         The Aegis configuration, governing much of how we use Aegis to
  21         build, test, control source, etc.
  22
  23 etc/
  24         A subdirectory for miscellaneous things that we need.  Right
  25         now, it has copies of Python modules that we use for testing,
  26         and which we don't want to force people to have to install on
  27         their own just to help out with SCons development.
  28
  29 runtest.py
  30 runtest.sh
  31         Scripts for running our tests.  The Python version is used
  32         by Aegis for running tests against a copy of the source as
  33         extracted from an archive.  The shell version runs tests against
  34         the local src/ tree, so you don't have to do a build before
  35         testing your changes.  (Hmm, that should probably just be an
  36         option to runtest.py...)
  37
  38 src/
  39         Where the actual source code is kept, of course.
  40
  41 template/
  42         Template files, used by Aegis to give you a head start when you
  43         aenf or aent a new file.  I haven't been keeping these up to
  44         date...
  45
  46 test/
  47         End-to-end tests of the SCons utility itself.  These are
  48         separate from the individual module unit tests, which live
  49         side-by-side with the modules under src/.