README

   1 ==========================================================================
   2 Modular C++ Build System Template
   3 ==========================================================================
   4 # Author  : Christopher Batten
   5 # Date    : September 24, 2008
   6 # Version : (under version control)
   7
   8 This is a template for the Modular C++ Build System. Please refer to the
   9 following documentation for more information on the build system:
  10
  11  - 'mcppbs-uguide.txt'    : Modular C++ Build System User Guide
  12  - 'utst/utst-uguide.txt' : Unit Testing Framework User Guide
  13  - 'style-guide.txt'      : C++ Coding Style Guide
  14
  15 Developers should eventually replace this 'README' file with information
  16 on their new project. It is recommended that the new 'README' file keep
  17 pointers to the above documentation so that end-users can learn about
  18 the build system. You may also want to keep the version information
  19 around so that you know what version of the build system you are using.
  20
  21 --------------------------------------------------------------------------
  22 Template Instantiation
  23 --------------------------------------------------------------------------
  24
  25  - Update project metadata (name, maintainer, etc) in 'configure.ac'
  26  - Run 'autoconf && autoheader' in project's root directory
  27  - Add subprojects and update the list in 'configure.ac'
  28
  29 --------------------------------------------------------------------------
  30 Build Steps
  31 --------------------------------------------------------------------------
  32
  33  % mkdir build
  34  % cd build
  35  % ../configure
  36  % make
  37