Piojo

Dependencies

• CMake 2.6 (or any later version).
• (optional) Doxygen for docs generation.
• (optional) gcov/lcov for code coverage.

Build

$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local -DCMAKE_BUILD_TYPE=Release ..
$ make

To generate docs:

$ make doc

Usage

Read the API reference or navigate through test/ for code samples.

Development

Debug

$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local -DCMAKE_BUILD_TYPE=Debug ..
$ make

Testing / Coverage

$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/local -DCMAKE_BUILD_TYPE=Testing ..
$ make
$ CTEST_OUTPUT_ON_FAILURE=1 make test

Code Style

• Avoid lines with more than 80 characters.
• Avoid more than 3 levels of indentation.
• Avoid functions longer than 50 lines.
• Avoid functions with more than 5 arguments.
• Predicate (boolean) functions end with '_p'.
• Interface type names end with '_if'.
• Function/Callback type names end with '_cb'.
• Any other type names end with '_t'.
• Don't use typedef to hide pointer types. (exception: functions/callbacks)