cpp/README

   1 This is only tested on Linux. With some trouble, it might work on Windows as well.
   2
   3 To build the library only:
   4 - Install scons
   5 - Run "scons lib" in this folder (cpp).
   6
   7 To build the unit tests:
   8 - Install cppunit (libcppunit-dev on Ubuntu)
   9 - Run "scons tests"
  10 - Run "testrunner" in the build folder
  11
  12 To build the test utility:
  13 - Install Magick++ (libmagick++-dev on Ubuntu)
  14 - Run "scons zxing"
  15
  16 An simple example application is now also included, but no compilation instructions yet.
  17
  18 To clean:
  19 - Run "scons -c all"
  20
  21 To use the test utility:
  22 - Basic usage:
  23   - "mkdir testout"
  24   - "zxing testout *.jpg > report.html"
  25 - With the zxing test data, from the cpp folder:
  26   - "mkdir testout"
  27   - "build/zxing testout ../core/test/data/blackbox/qrcode-*/* > report.html"
  28
  29 To format the code:
  30  - Install astyle
  31  - Run ./format
  32
  33 To profile the code (very useful to optimize the code):
  34  - Install valgrind
  35  - "valgrind --tool=callgrind build/zxing - path/to/test/data/*.jpg > report.html"
  36  - kcachegrind is a very nice tool to analize the output