https://github.com/cpp20120/cmake_boilerplate
Cmake Projects Boilerplate with batteries inlcuded
https://github.com/cpp20120/cmake_boilerplate
boilerplate build cmake docs doxygen format graphics ninja shaders static-analysis
Last synced: about 2 months ago
JSON representation
Cmake Projects Boilerplate with batteries inlcuded
- Host: GitHub
- URL: https://github.com/cpp20120/cmake_boilerplate
- Owner: cpp20120
- License: mit
- Created: 2025-04-24T07:23:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-08T11:10:30.000Z (8 months ago)
- Last Synced: 2025-07-08T12:26:11.632Z (8 months ago)
- Topics: boilerplate, build, cmake, docs, doxygen, format, graphics, ninja, shaders, static-analysis
- Language: CMake
- Homepage: https://deepwiki.com/cpp20120/cmake_boilerplate/1-overview
- Size: 292 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My boilerplate for cmake projects with ci/cd
[](https://cmake.org/)
[](https://vcpkg.io/)
[](LICENSE)
[](https://github.com/cpp20120/cmake_boilerplate).
Structure:
```sh
├── .github/workflows
│ └── build_cmake.yml
├── build(contains generation from cmake(ninja.build) and also contains compile_commands.json
├── cmake (contains cmake scripts for project)
├── docs
| └── CMakeLists.txt
│ └── generate_docs.py
│ └── Doxyfile.in
├── include
│ └── *.hpp
├── lib
| └──lib1_name (contains first library name)
| ├── cmake (contains cmake scripts for library)
| ├── include
│ └── *.hpp
| ├── src
│ └── CMakeLists.txt
| └── *.cpp
| ├── test (contains test for lib)
| └── CMakeLists.txt
| └── lib_test_*.cpp(name will changes to library component name)
| └──lib2_name (contains second library name)
| ├── cmake (contains cmake scripts for library)
| ├── include
│ └── *.hpp
| ├── src
│ └── CMakeLists.txt
| └── *.cpp
| ├── test (contains test for lib)
| └── CMakeLists.txt
| └── lib_test_*.cpp(name will changes to library component name)
│── shaders(for graphics project)
│ └── *.frag/.vert
├── src
│ └── CMakeLists.txt
│ └── *.cpp
├── test
| └──fuzz_test (contains fuzz tests)
| └──CMakeLists.txt
│ └── CMakeLists.txt
│ └── test_*.cpp
├── .clang-format
├── .clang-tidy
├── .gitignore
├── build_all.(ps/sh) (build all script for unix and windows)
├── CMakeLists.txt
├── CMakePresets.json
├── compile_commands.json -> build/compile_commands.json(for clangd in nvim/vsc)
├── vcpkg.json
├── Dockerfile
├── LICENSE
└── README.md
```
I use [vcpkg](https://vcpkg.io/en/index.html) for pm(in [windows & linux](https://github.com/cppshizoidS/cmake_boilerplate/tree/vcpkg)), [cmake](https://cmake.org/) for generator files for [ninja-build](https://ninja-build.org/), [clang-format](https://clang.llvm.org/docs/ClangFormat.html) for format and [doxygen](https://www.doxygen.nl/manual/index.html) for generate docs, [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) for linting, [libfuzzer](https://llvm.org/docs/LibFuzzer.html) for fuzz tests.
GTest for Unit Test and Ctest for running tests. Lcov/Gcov for test coverage. It can be used for graphics project.
---
This template contains everything you need:
* ready CMakeLists.txt with specific options for windows
* cmake presets
* vcpkg.json
* cript for install all needed packages(for debain based, fedora, arch based & macos)
* github.ci/gitlab.ci
* .gitignore
* clang-format
* clang-tidy
* cmake-format
* gcov, lcov
* mold/lld linker(available for gcc/clang)
* lib build flags
* library versioning
* setuped doxygen(with graphviz)
* setuped installers for windows(NSIS) and packages for deb and rpm
* caching on ci
* basic setup for nvim zsh OMZ
* IWYU
* setuped CTest and GTest
* setuped fuzz testing
* shader build script
* different configurations: debug, release...
* debug configs enable flags for most checks for compilers (clang/gcc and msvc)(some may confict need to pick what and when need)
* docker setup
* static analysis tools setuped
* sanizers setuped
* scritps for parallel formatting (code and cmake)
* Visual Studio cmake settings preset pick
### Build Debug
```sh
mkdir -p build/debug
cd build/debug
cmake --preset debug
cmake --build --preset build-debug
```
### Build Release:
```sh
mkdir -p build/release
cd build/release
cmake --preset release
cmake --build --preset build-release
```
### Vcpkg debug build:
```sh
cmake --preset vcpkg-debug
cmake --build --preset build-vcpkg-debug
```
### Vcpkg release build:
```sh
cmake --preset vcpkg-release
cmake --build --preset build-vcpkg-release
```
### Build with sanitazers:
## Address sanitizer
```sh
cmake --preset debug-sanitize-address
cmake --build --preset build-debug-sanitize-address
```
## Thread sanitizer
```sh
cmake --preset debug-sanitize-thread
cmake --build --preset build-debug-sanitize-thread
```
## Undefined behavior sanitizer
```sh
cmake --preset debug-sanitize-undefined
cmake --build --preset build-debug-sanitize-undefined```
```
(specify sanitizer what you need)
### Testing
## Run Fuzz Testing
```sh
cmake -B build -DENABLE_FUZZING=ON -DCMAKE_CXX_COMPILER=clang++
cmake --build build --target fuzz_target
```
Manually
```sh
./build/fuzz/fuzz_target ./fuzz/corpus -max_len=1024 -runs=100000
```
From CTest
```sh
ctest -R fuzz_target_test
```
Auto crash test
```sh
mkdir -p artifacts/crashes
./build/fuzz/fuzz_target -artifact_prefix=artifacts/crashes/
```
With vcpkg
```sh
cmake --preset fuzz-vcpkg
cmake --build --preset build-fuzz-vcpkg
```
## Run all tests (release build)
```sh
ctest --preset test-all
```
## Run tests with address sanitizer
```sh
ctest --preset test-sanitize-address
```
## Run specific test suite
```sh
ctest --preset test-library1
```
## Run docs generation
```sh
cmake --build . --target docs
```