khofesh / cpp-template

Template For C++ Projects

This is a template for C++ projects. What you get:

• Library, executable and test code separated in distinct folders
• Use of modern CMake for building and compiling
• External libraries installed and managed by
  • CMake's FetchContent OR
  • Conan Package Manager OR
  • VCPKG Package Manager
• Unit testing using Catch2
• General purpose libraries: JSON, spdlog, cxxopts and fmt
• Continuous integration testing with Github Actions and pre-commit
• Code coverage reports, including automatic upload to Codecov
• Code documentation with Doxygen and Github Pages

Structure

├── CMakeLists.txt
├── app
│   ├── CMakesLists.txt
│   └── main.cc
├── cmake
│   └── cmake modules
├── docs
│   ├── Doxyfile
│   └── html/
├── external
│   ├── CMakesLists.txt
│   ├── ...
├── src
│   ├── CMakesLists.txt
│   ├── my_lib.h
│   └── my_lib.cc
└── tests
    ├── CMakeLists.txt
    └── main.cc

Library code goes into src/, main program code in app/ and tests go in tests/.

Software Requirements

• CMake 3.16+
• GNU Makefile
• Doxygen
• Conan or VCPKG
• MSVC 2017 (or higher), G++9 (or higher), Clang++9 (or higher)
• Code Coverage (only on GNU|Clang): lcov, gcovr

Building

First, clone this repo and do the preliminary work:

git clone --recursive https://github.com/franneck94/CppProjectTemplate
make prepare

• App Executable

cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --config Release --target main
cd app
./main

• Unit testing

cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build . --config Debug --target unit_tests
cd tests
./unit_tests

• Documentation

cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build . --config Debug --target docs

• Code Coverage (Unix only)

cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=ON ..
cmake --build . --config Debug --target coverage

For more info about CMake see here.