-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replicate the rest of the template-janitor changes.
- Loading branch information
Showing
2 changed files
with
7 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,16 @@ | ||
| # cmake_template | ||
| # Adobe Contract Checking | ||
|
|
||
| [](https://github.com/cpp-best-practices/cmake_template/actions/workflows/ci.yml) | ||
| [](https://codecov.io/gh/cpp-best-practices/cmake_template) | ||
| [](https://github.com/cpp-best-practices/cmake_template/actions/workflows/codeql-analysis.yml) | ||
| [](https://github.com/stlab/adobe-contract-checks/actions/workflows/ci.yml) | ||
| [](https://codecov.io/gh/stlab/adobe-contract-checks) | ||
| [](https://github.com/stlab/adobe-contract-checks/actions/workflows/codeql-analysis.yml) | ||
|
|
||
| ## About cmake_template | ||
| ## Adobe Contract Checking | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| ## 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'](https://github.com/cpp-best-practices/cmake_template/generate) | ||
| 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](README_dependencies.md) | ||
| * [Building Details](README_building.md) | ||
| * [Troubleshooting](README_troubleshooting.md) | ||
| * [Docker](README_docker.md) | ||
|
|
||
| ## Testing | ||
|
|
||
| See [Catch2 tutorial](https://github.com/catchorg/Catch2/blob/master/docs/tutorial.md) | ||
|
|
||
| ## Fuzz testing | ||
|
|
||
| See [libFuzzer Tutorial](https://github.com/google/fuzzing/blob/master/tutorial/libFuzzerTutorial.md) | ||
|
|
||
|
|