aboutsummaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
index 625dc67..5d743ce 100644
--- a/readme.txt
+++ b/readme.txt
@@ -4,4 +4,19 @@ system.
Dependencies: Python3 and Python-Ply
+Running:
+
+Builder requires that you have a source directory and a build directory
+and that these two are different. In your source root must exist a file
+called 'builder.txt'. To generate the build system run this command:
+
+builder.py <source directory> <build directory>
+
+You can omit either of the two directories, and Builder will subsitute
+the current directory and autodetect what you mean. This mean that you
+can do things like this:
+
+cd source_root; mkdir build; cd build; builder ..
+cd source_root; mkdir build; builder build
+
For questions contact jpakkane@gmail.com.