NOTE: This Project Is Archived

All efforts to maintain "Best Practices" CMake templates are being merged into https://github.com/cpp-best-practices/cmake_template

Important the new cmake_template is simplified in many ways to make it more maintainable, and the goal will be to always keep it simple.

cmake_conan_boilerplate_template

About cmake_conan_boilerplate_template

This is a C++ Best Practices GitHub template for getting up and running with C++ quickly.

By default (collectively known as ENABLE_DEVELOPER_MODE)

Address Sanitizer and Undefined Behavior Sanitizer enabled where possible
Warnings as errors
clang-tidy and cppcheck static analysis
conan for dependencies

It includes

a basic CLI example
examples for fuzz, unit, and constexpr testing
large github action testing matrix

It requires

cmake
conan
a compiler

If you want a more complex example project, check out the cpp_starter_project.

Ths Boilerplate project will merge new features first, then they will be merged (as appropriate) into cpp_starter_project.

Getting Started

Use the Github template

First, click the green Use this template button near the top of this page. This will take you to Github's 'Generate Repository' page. Fill in a repository name and short description, and click 'Create repository from template'. This will allow you to create a new repository in your Github account, prepopulated with the contents of this project.

After creating the project please wait until the cleanup workflow has finished setting up your project and commited the changes.

Now you can clone the project locally and get to work!

git clone https://github.com/<user>/<your_new_repo>.git

More Details

Testing

See Catch2 tutorial

Fuzz testing

See libFuzzer Tutorial

Uh oh!

License

cpp-best-practices/cmake_conan_boilerplate_template

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Contributors 38

Uh oh!

Languages

Error
Looks like something went wrong!

Packages