Project template for CMake C++ projects.
- cmake
- doctest (if
BUILD_TESTSis enabled) - google benchmark (if
BUILD_BENCHMARKis enabled) - doxygen + sphinx + breathe for generating the documentation
| Directory/File | Content |
|---|---|
| .github | templates for pull requests and issues |
| benchmarks | Benchmarking with google benchmark |
| cmake | cmake files such as options and configuration template |
| doc | documentation + respective configuration files |
| examples | applications based on library in myproject/ |
| myproject | code of library |
| tests | test cases for the library |
| .clang-format | clang-format file for consequent formatting |
| .gitignore | gitignore |
| .travis.yml | travisCI configuration |
- building documentation via CMake
The documentation can be build via the following commands:
cd doc
doxygen
make htmlThis repository is licensed under the Unlicense License. Therefore, you can do whatever you want with this template.