Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.73 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.73 KB

Using this project will give you a modern C++ dev environnement, including Docker image for CI and CI jobs Build & Check.

Take over the README below !

[ Describe your project here ]

Dependencies

Build system

  • CMake 3.19 or later (to be able to use CMakePresets)
  • C++ compiler with C++23 support (clang 17)
  • ninja-build

Static analyzes

  • libsanitizer
  • clang-tidy
  • cppcheck

Formatter

  • clang-format

CI status

Build & Check

Documentation

[ Add your public API documentation here ] and link to private implem doc

Boilerplate Notes

CMake usage of Presets

  • This boilerplate uses the presets feature (CMake 3.19), but we still keep the presets to minimal (KISS principle), How?
    • Only one config preset
    • Multiple build presets (release, debug...)

This means we require a multi-configuration build system to support both Debug and Release builds in a single configuration step. It is designed to work with generators like Ninja Multi-Config (Available on all Linux systems) or Visual Studio, XCode... Which allow specifying build configurations (Debug, Release, etc.) at build time. Single-configuration generators, such as Makefiles, are not supported, as they require separate build directories for each configuration. If you really need that, edit the configurePresets section of the CMakePresets.json file. Copy paste this to Chatgpt if it's not clear.