improve install script
[trackerpp.git] / README.md
index 13c713b..a1112a9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,45 @@
 Tracker++ cpp version on Linux (arm)
 
-## install dependencies
+## Install dependencies
 
-- log4cpp : logger utils
-- opencv
-- eigen : matrix library of C++
+- opencv - 3.4.1
 
-`apt-get install liblog4cpp5-dev libopencv-dev libeigen3-dev`
+    Run  `script/install_opencv.sh` to build and install opencv into /usr/local
+Refer this page <https://docs.opencv.org/3.4.1/d7/d9f/tutorial_linux_install.html>
 
-## Build 
+- log4cpp : logger utils
+- eigen : matrix library of C++
+- scons
+   `apt-get install liblog4cpp5-dev libeigen3-dev scons`
+   
+- boost-python 
+    - `apt-get install libpython-dev python-dev`
+    - build boost with python
+    - `pip install scipy numpy sklearn`
 
-`make all`
+Boost has been already installed when build ArmNN, but not enable python module,
+so need to re-install boost 1.64 by following command. add `--with-python`
+`sudo ./b2 install link=static cxxflags=-fPIC --with-filesystem --with-test --with-log --with-program_options --with-python`
+<https://www.boost.org/doc/libs/1_67_0/libs/python/doc/html/building/installing_boost_python_on_your_.html>
 
-### Run
 
-`./main`
+## Build with `scons`
 
+- Run `scons` 
+    To build folder `src/` and `main.cpp`. `libtracker.a` and `main` will be generated
 
-## Build with `scons`
-install scons tool `apt-get install scons`
+- Run `scons --all` 
+    To build folder `src/` and `test/` and `main.cpp`. `libtracker.a` , `main`,
+    and `test/TestMain` will be generated. Run `TestMain` to run all the unit
+    test 
+    
+- Run `scons -c` or  `scons --all -c` 
+    To clean 
 
-- Run `scons` to build the `src/` and `main`. It will generate a library
-`libtracker.a` and an executable file `main` under current folder.
+### Run 
 
-- 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`
+`./main`
 
-- Run `scons --all -c` to clean.
+### Log
+Logger config file is located at `config/log4cpp.properties`. By default, log
+file is `/tmp/trackerpp.log`