cmake_template

About cmake_template

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

By default (when building as the top-level project)

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

It includes

• a basic CLI example
• examples for fuzz, unit, and constexpr testing
• large GitHub action testing matrix
• WebAssembly build support with automatic GitHub Pages deployment

Live Demo: If you enable GitHub Pages in your project created from this template, you'll have a working example like this:

• Main: https://cpp-best-practices.github.io/cmake_template/
• Develop: https://cpp-best-practices.github.io/cmake_template/develop/

The main branch deploys to the root, develop to /develop/, and tags to /tagname/.

It requires

• cmake
• a compiler

This project gets you started with a simple example of using FTXUI, which happens to also be a game.

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 committed 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

• Dependency Setup
• Building Details
• Docker

Testing

See Catch2 tutorial

Fuzz testing

See libFuzzer Tutorial