]> git.tdb.fi Git - builder.git/blob - Readme.txt
Some fixes to library and header searching
[builder.git] / Readme.txt
1 Builder
2 Copyright © 2006  Mikko Rasa, Mikkosoft Productions
3 Version 0.1
4
5
6 Builder is a program for building other programs, similar to make, scons and
7 others.  It is specifically designed to suit my needs, with the goal of
8 minimizing the amount of per-package configuration.
9
10
11 * Building Builder
12
13 Builder is normally built using itself.  However, if you just downloaded the
14 source and don't yet have a Builder binary, how is that possible?  To resolve
15 this problem, there's a script called bootstrap.sh in the Builder main
16 directory.  Before running it, make sure you have the following libraries
17 available:
18
19 MSP libraries: core datafile path strings io
20
21 Others: sigc++-2.0
22
23 Since the MSP libraries are also normally built with Builder, the script will
24 need to have their sources available.  By default, it will look at the parent
25 directory of builder.  You can change this by setting the LIBPATH evironment
26 variable for the script.  If everything goes well, you should have a
27 builder-stage1 binary that you can use to build a normal version of Builder.
28
29
30 * Using Builder in your project
31
32 To use Builder, you need to create a Build file that tells what it should
33 build.  This file defines two main types of entities: packages and components.
34 usually there is only one package definition in a Build file.
35
36 The Build file uses a C-like structured language.  It consists of statements
37 and blocks.  Statements are terminated with a semicolon (';').  Blocks are
38 enclosed in braces ('{' and '}').  If a statement contains a block of
39 substatements, the semicolon comes after the closing brace.
40
41 For a simple example, look at Builder's own Build file.