Readme.txt

   1 Builder 0.9 Readme
   2
   3
   4 1. Description
   5
   6 Builder is a program for building other programs, similar to make, scons and
   7 others.  Its main design goals are minimizing duplication of configuration
   8 between packages and being as fast as possible.  Features include integrated
   9 configuration and dependency resolution C sources.
  10
  11
  12 2. Building Builder
  13
  14 Builder is normally built using itself.  However, if you just downloaded the
  15 source and don't yet have a Builder binary, how is that possible?  To resolve
  16 this problem, there's a script called bootstrap.sh in the Builder main
  17 directory.  Before running it, make sure you have the following libraries
  18 available:
  19
  20 MSP libraries: core datafile fs strings io
  21
  22 Others: sigc++-2.0
  23
  24 Since the MSP libraries are also normally built with Builder, the script will
  25 need to have their sources available.  By default, it will look at the parent
  26 directory of builder.  You can change this by setting the LIBPATH evironment
  27 variable for the script.  If everything goes well, you should have a
  28 builder-stage1 binary that you can use to build a normal version of Builder.
  29
  30 NOTE: You will need to copy builderrc as ~/.builderrc in order to build some
  31 packages.  This will be rectified in the future.
  32
  33
  34 3. Using Builder to build projects
  35
  36 In the simplest and most common case, Builder is invoked in the package's root
  37 directory without any arguments.  An arbitary working directory may be
  38 specified with -C, or an alternative Build file with -f.
  39
  40 To build a subset of the targets known to the package, the desired targets can
  41 be named on the command line.  Note that if -C is used, the targets will be
  42 interpreted relative to that directory, not the one where Builder is invoked
  43 from.
  44
  45 To change package configuration, arguments of the form key=value may be given.
  46 By default they will only affect the current package, but with the -A switch,
  47 all active packages may be configured at once.
  48
  49
  50 4. Using Builder in your project
  51
  52 To use Builder, you need to create a Build file that tells what it should
  53 build.  This file defines two main types of entities: packages and components.
  54 usually there is only one package definition in a Build file.
  55
  56 The Build file uses a C-like structured language.  It consists of statements
  57 and blocks.  Statements are terminated with a semicolon (';').  Blocks are
  58 enclosed in braces ('{' and '}').  If a statement contains a block of
  59 substatements, the semicolon comes after the closing brace.
  60
  61 For a simple example, look at Builder's own Build file.
  62
  63
  64 5. Contact information
  65
  66 The latest releases can be found at http://www.tdb.fi/builder.shtml
  67
  68 Bug reports, feature reports etc. may be sent to tdb@tdb.fi
  69
  70 Read-only SVN access is available at http://svn.tdb.fi/builder
  71
  72
  73 6. License
  74
  75 Builder is copyright © 2006-2008  Mikko Rasa, Mikkosoft Productions
  76
  77 This program is free software; you can redistribute it and/or modify
  78 it under the terms of the GNU General Public License as published by
  79 the Free Software Foundation; either version 2 of the License, or
  80 (at your option) any later version.
  81
  82 This program is distributed in the hope that it will be useful,
  83 but WITHOUT ANY WARRANTY; without even the implied warranty of
  84 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  85 GNU General Public License for more details.
  86
  87 You should have received a copy of the GNU General Public License along
  88 with this program; if not, write to the Free Software Foundation, Inc.,
  89 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  90
  91 Full license text can be found in License.txt.
  92
  93
  94 7. Version history
  95
  96 0.9
  97 - First released version