A template repository to quick-start C++ development.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
CMakeModules
docs
include/CppTemplate
src
test/unit
tools
.gitignore
.travis.yml
CHANGELOG.md
CMakeLists.txt
CMakeLists.txt.in
README.rst
doxygen.conf

README.rst

CppTemplate

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

https://travis-ci.org/mbedded-ninja/CppTemplate.svg?branch=master

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://mbedded-ninja.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