NOTE This is undergoing a major overhaul on a new branch currently.
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
- CPM for dependencies
It includes
- a basic CLI example
- examples for fuzz, unit, and constexpr testing
- large github action testing matrix
It requires
- cmake
- a compiler
This project gets you started with a simple example of using FTXUI, which happens to also be a game.
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
See Catch2 tutorial