X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=Readme.txt;h=eb471a8c1050fb18dcbe3b605e8a742b260b905c;hb=afed9d3a6326790b77b786cbc1e76b725a14dbe5;hp=c0004ad9ad4f866fd350acb8c860a4ab0059a1ab;hpb=0d80cabf649b931b26e7055385156c75a7385d35;p=builder.git diff --git a/Readme.txt b/Readme.txt index c0004ad..eb471a8 100644 --- a/Readme.txt +++ b/Readme.txt @@ -1,5 +1,5 @@ Builder -Copyright © 2006 Mikko Rasa, Mikkosoft Productions +Copyright © 2006-2008 Mikko Rasa, Mikkosoft Productions Version 0.1 @@ -16,12 +16,26 @@ this problem, there's a script called bootstrap.sh in the Builder main directory. Before running it, make sure you have the following libraries available: -MSP libraries: misc core parser path regex++ getopt++ +MSP libraries: core datafile fs strings io Others: sigc++-2.0 Since the MSP libraries are also normally built with Builder, the script will -need to have their sources available. By default, it will look at ../libs. -You can change this by setting the LIBPATH evironment variable for the script. -If everything goes well, you should have a builder-stage1 binary that you can -use to build a normal version of Builder. +need to have their sources available. By default, it will look at the parent +directory of builder. You can change this by setting the LIBPATH evironment +variable for the script. If everything goes well, you should have a +builder-stage1 binary that you can use to build a normal version of Builder. + + +* Using Builder in your project + +To use Builder, you need to create a Build file that tells what it should +build. This file defines two main types of entities: packages and components. +usually there is only one package definition in a Build file. + +The Build file uses a C-like structured language. It consists of statements +and blocks. Statements are terminated with a semicolon (';'). Blocks are +enclosed in braces ('{' and '}'). If a statement contains a block of +substatements, the semicolon comes after the closing brace. + +For a simple example, look at Builder's own Build file.