Add DependencyCache to speed up build preparation

[builder.git] / Readme.txt

diff --git a/Readme.txt b/Readme.txt
index 9579372aa448a964f6a0506721d6342e29b637fd..6b6e3569e48c45283d450be887e66b882bfce2b7 100644 (file)
--- a/Readme.txt
+++ b/Readme.txt
@@ -16,7 +16,7 @@ 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 parser path strings
 
 Others: sigc++-2.0
 
@@ -25,3 +25,17 @@ 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.