Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

orgarten/CppTemplate

Repository files navigation

Build Status

C++Template

Project template for CMake C++ projects.

Dependencies

  • cmake
  • doctest (if BUILD_TESTS is enabled)
  • google benchmark (if BUILD_BENCHMARK is enabled)
  • doxygen + sphinx + breathe for generating the documentation

Structure

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

Todo

  • building documentation via CMake

Building documentation

The documentation can be build via the following commands:

cd doc
doxygen
make html

License

This repository is licensed under the Unlicense License. Therefore, you can do whatever you want with this template.