|
1 | | -# ftxui_template |
| 1 | +# my_awesome_game |
2 | 2 |
|
3 | | -[](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/ci.yml) |
4 | | -[](https://codecov.io/gh/cpp-best-practices/ftxui_template) |
5 | | -[](https://lgtm.com/projects/g/cpp-best-practices/ftxui_template/context:cpp) |
6 | | -[](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/codeql-analysis.yml) |
| 3 | +[](https://github.com/lefticus/my_awesome_game/actions/workflows/ci.yml) |
| 4 | +[](https://codecov.io/gh/lefticus/my_awesome_game) |
| 5 | +[](https://github.com/lefticus/my_awesome_game/actions/workflows/codeql-analysis.yml) |
7 | 6 |
|
8 | | -## About ftxui_template |
| 7 | +LGTM Has to be set up manually after template is created: |
9 | 8 |
|
10 | | -This is a C++ Best Practices GitHub template for getting up and running with C++ quickly. |
| 9 | +[](https://lgtm.com/projects/g/lefticus/my_awesome_game/context:cpp) |
11 | 10 |
|
12 | | -By default (collectively known as `ENABLE_DEVELOPER_MODE`) |
| 11 | +## About my_awesome_game |
| 12 | +This is an awesome submission to the C++ Best Practices Game Jam |
13 | 13 |
|
14 | | - * Address Sanitizer and Undefined Behavior Sanitizer enabled where possible |
15 | | - * Warnings as errors |
16 | | - * clang-tidy and cppcheck static analysis |
17 | | - * conan for dependencies |
18 | | - |
19 | | -It includes |
20 | | - |
21 | | - * a basic CLI example |
22 | | - * examples for fuzz, unit, and constexpr testing |
23 | | - * large github action testing matrix |
24 | | - |
25 | | -It requires |
26 | | - |
27 | | - * cmake |
28 | | - * conan |
29 | | - * a compiler |
30 | | - |
31 | | - |
32 | | -This project gets you started with a simple example of using FTXUI, which happens to also be a game. |
33 | | - |
34 | | - |
35 | | -## Getting Started |
36 | | - |
37 | | -### Use the Github template |
38 | | -First, click the green `Use this template` button near the top of this page. |
39 | | -This will take you to Github's ['Generate Repository'](https://github.com/cpp-best-practices/ftxui_template/generate) page. |
40 | | -Fill in a repository name and short description, and click 'Create repository from template'. |
41 | | -This will allow you to create a new repository in your Github account, |
42 | | -prepopulated with the contents of this project. |
43 | | - |
44 | | -After creating the project please wait until the cleanup workflow has finished |
45 | | -setting up your project and commited the changes. |
46 | | - |
47 | | -Now you can clone the project locally and get to work! |
48 | | - |
49 | | - git clone https://github.com/<user>/<your_new_repo>.git |
50 | 14 |
|
51 | 15 | ## More Details |
52 | 16 |
|
53 | 17 | * [Dependency Setup](README_dependencies.md) |
54 | 18 | * [Building Details](README_building.md) |
55 | 19 | * [Troubleshooting](README_troubleshooting.md) |
56 | 20 | * [Docker](README_docker.md) |
57 | | - |
58 | | -## Testing |
59 | | - |
60 | | -See [Catch2 tutorial](https://github.com/catchorg/Catch2/blob/master/docs/tutorial.md) |
61 | | - |
62 | | -## Fuzz testing |
63 | | - |
64 | | -See [libFuzzer Tutorial](https://github.com/google/fuzzing/blob/master/tutorial/libFuzzerTutorial.md) |
65 | | - |
66 | | - |
0 commit comments