This project demonstrates the usage of some common c++ tools for a project.
- Catch for testing
- Doxygen for documentation
- Clang-format should be used to comform to the Google C++ Style Guide
- cpplint.py is included to further conform to the style guide
When you build the project everything will be build in the bin directory. The bin and docs directories are excluded from git in the .gitignore file.
cd bin/
cmake ../
make
Doxygen runs with the configuration set in the Doxyfile. For this project running Doxygen from the root of the directory tree will generate the docs in the docs directory.
./Doxygen
A separate test executable is built in the CMakeList.txt. You can run the tests by running the test executable in the bin directory. You can see all the tests written in the test directory.