cpp/README

   1 This is only tested on Linux. With some trouble, it might work on Windows as well.
   2
   3 The build process uses scons, a build tool written in python. You'll
   4 need to have python installed, but scons installation is optional: a
   5 runtime copy of scons (called scons-local) is included with zxing. To
   6 use the included copy of scons-local, where the instructons says enter
   7 "scons", enter "python scons/scons.py" instead. For example, to build
   8 the library only, you'd use "python scons/scons.py lib" instead of
   9 "scons lib".
  10
  11 To build the library only:
  12 - Run "scons lib" in this folder (cpp)
  13
  14 To build the unit tests:
  15 - Install cppunit (libcppunit-dev on Ubuntu)
  16 - Run "scons tests"
  17 - Run "testrunner" in the build folder
  18
  19 To build the test utility:
  20 - Install Magick++ (libmagick++-dev on Ubuntu)
  21 - Run "scons zxing"
  22
  23 An simple example application is now also included, but no compilation instructions yet.
  24
  25 To clean:
  26 - Run "scons -c all"
  27
  28 To use the test utility:
  29 - Basic usage:
  30   - "mkdir testout"
  31   - "zxing testout *.jpg > report.html"
  32 - With the zxing test data, from the cpp folder:
  33   - "mkdir testout"
  34   - "build/zxing testout ../core/test/data/blackbox/qrcode-*/* > report.html"
  35
  36 To format the code:
  37  - Install astyle
  38  - Run ./format
  39
  40 To profile the code (very useful to optimize the code):
  41  - Install valgrind
  42  - "valgrind --tool=callgrind build/zxing - path/to/test/data/*.jpg > report.html"
  43  - kcachegrind is a very nice tool to analize the output