Skip to content

gbmhunter/CppTemplate

Repository files navigation

CppTemplate

A template repository to quick-start C++ development.

image

image

Features

  • C++14 template/example project with example header files and source files
  • CMake-based build system
  • Automatic build script in ./tools/
  • gtest-based unit tests (and a make target to automatically build/run unit tests)
  • CI functionality using TravisCI (with sudo available on Ubuntu 14.04)
  • Semantic versioning and keepachangelog.com-based Changelog format
  • Doyxgen support (example doxygen.conf file provided) coupled with GitHub pages support, see https://gbmhunter.github.io/CppTemplate/index.html for example documentation.
  • Code coverage support using lcov and https://codecov.io. Code coverage is only generated for the files which matter, the source code in src/ and include/ directories.

Automatic Build

~/CppTemplate$ ./tools/build.sh

Manual Build

~/CppTemplate$ mkdir build
~/CppTemplate$ cd build/
~/CppTemplate/build$ cmake ..
~/CppTemplate/build$ make
~/CppTemplate/build$ make run_unit_tests
~/CppTemplate/build$ sudo make install

To Generate Documentation

~/CppTemplate$ doxygen doxygen.conf