README

   1 # Documentation
   2
   3 Generate documentation by executing command generate_documentation.sh
   4 from doc directory. Documentation will be generated in doc/html directory.
   5 There is also GUI tool named doxywizard.
   6
   7     cd ./doc
   8     ./generate_documentation.sh
   9
  10
  11 # Code formatting
  12
  13 We use astyle for code formatting.
  14 Get the latest version from http://sourceforge.net/projects/astyle/files/astyle/
  15 (at least v2.04). You can find the options file in the root of the project.
  16 For example to format all .cpp and .hpp files run in the project directory:
  17
  18     astyle --options=./astylerc --recursive ./*.cpp ./*.hpp