Fix issue boostpython not stopped by Ctrl+c
[trackerpp.git] / README.md
index 51122bf..202ad06 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,21 @@
 Tracker++ cpp version on Linux (arm)
 
 ## install dependencies
-`apt-get install liblog4cpp5-dev libopencv-dev`
+
+- log4cpp : logger utils
+- opencv
+- eigen : matrix library of C++
+- boost-python 
+    - `apt-get install libpython-dev python-dev`
+    - build boost with python
+    - `pip install scipy numpy sklearn`
+<https://www.boost.org/doc/libs/1_67_0/libs/python/doc/html/building/installing_boost_python_on_your_.html>
+
+As boost has already 
+
+`sudo ./b2 install link=static cxxflags=-fPIC --with-filesystem --with-test --with-log --with-program_options --with-python`
+
+`apt-get install liblog4cpp5-dev libopencv-dev libeigen3-dev`
 
 ## Build 
 
@@ -10,3 +24,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.