Add Sconscript for unit test

[trackerpp.git] / README.md

diff --git a/README.md b/README.md
index 51122bf..36d7542 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,3 +10,15 @@ Tracker++ cpp version on Linux (arm)
 ### Run
 
 `./main`
+
+
+## Build with `scons`
+install scons tool `apt-get install scons`
+
+- Run `scons` to build the `src/` and `main`. It will generate a library
+`libtracker.a` and an executable file `main` under current folder.
+
+- Run `scons --all` to build source and `test` file. A executable file `TestMain`,
+which is used to run the unit test, will be generated under `test`
+
+- Run `scons --all -c` to clean.