From: Mikko Rasa <tdb@tdb.fi>
Date: Fri, 10 Aug 2007 18:59:42 +0000 (+0000)
Subject: Add a short section about using Builder to Readme.txt
X-Git-Tag: 0.9~33
X-Git-Url: http://git.tdb.fi/?a=commitdiff_plain;h=f1de8cfebfc1d052835fd0c61fde7a4a53650c00;p=builder.git

Add a short section about using Builder to Readme.txt
---

diff --git a/Readme.txt b/Readme.txt
index dda34d6..6b6e356 100644
--- a/Readme.txt
+++ b/Readme.txt
@@ -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.