Change notes for 1.6

[zxing.git] / cpp / README

diff --git a/cpp/README b/cpp/README
index e5a9fe8..2059378 100644 (file)
--- a/cpp/README
+++ b/cpp/README
@@ -1,8 +1,15 @@
 This is only tested on Linux. With some trouble, it might work on Windows as well.
 
+The build process uses scons, a build tool written in python. You'll
+need to have python installed, but scons installation is optional: a
+runtime copy of scons (called scons-local) is included with zxing. To
+use the included copy of scons-local, where the instructons says enter
+"scons", enter "python scons/scons.py" instead. For example, to build
+the library only, you'd use "python scons/scons.py lib" instead of
+"scons lib".
+
 To build the library only:
-- Install scons
-- Run "scons lib" in this folder (cpp).
+- Run "scons lib" in this folder (cpp)
 
 To build the unit tests:
 - Install cppunit (libcppunit-dev on Ubuntu)
@@ -13,6 +20,8 @@ To build the test utility:
 - Install Magick++ (libmagick++-dev on Ubuntu)
 - Run "scons zxing"
 
+An simple example application is now also included, but no compilation instructions yet.
+
 To clean:
 - Run "scons -c all"
 
@@ -28,3 +37,7 @@ To format the code:
  - Install astyle
  - Run ./format
 
+To profile the code (very useful to optimize the code):
+ - Install valgrind
+ - "valgrind --tool=callgrind build/zxing - path/to/test/data/*.jpg > report.html"
+ - kcachegrind is a very nice tool to analize the output