Skip to content

Commit 4c026ad

Browse files
author
Template Janitor
committed
Cleanup template and initialize repository
1 parent 26df903 commit 4c026ad

File tree

11 files changed

+17
-348
lines changed

11 files changed

+17
-348
lines changed

.github/FUNDING.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

.github/template/README.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/template/removal-list

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/template/template_name

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/template/template_repository

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/workflows/template-janitor.yml

Lines changed: 0 additions & 233 deletions
This file was deleted.

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ include(${_project_options_SOURCE_DIR}/Index.cmake)
4949

5050
# Set the project name and language
5151
project(
52-
myproject
52+
my_awesome_game
5353
VERSION 0.0.1
5454
DESCRIPTION ""
55-
HOMEPAGE_URL "%%myurl%%"
55+
HOMEPAGE_URL "https://github.com/lefticus/my_awesome_game"
5656
LANGUAGES CXX C)
5757

5858
set(GIT_SHA

LICENSE

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,20 @@
1-
# ftxui_template
1+
# my_awesome_game
22

3-
[![ci](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/ci.yml/badge.svg)](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/ci.yml)
4-
[![codecov](https://codecov.io/gh/cpp-best-practices/ftxui_template/branch/main/graph/badge.svg)](https://codecov.io/gh/cpp-best-practices/ftxui_template)
5-
[![Language grade: C++](https://img.shields.io/lgtm/grade/cpp/github/cpp-best-practices/ftxui_template)](https://lgtm.com/projects/g/cpp-best-practices/ftxui_template/context:cpp)
6-
[![CodeQL](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/cpp-best-practices/ftxui_template/actions/workflows/codeql-analysis.yml)
3+
[![ci](https://github.com/lefticus/my_awesome_game/actions/workflows/ci.yml/badge.svg)](https://github.com/lefticus/my_awesome_game/actions/workflows/ci.yml)
4+
[![codecov](https://codecov.io/gh/lefticus/my_awesome_game/branch/main/graph/badge.svg)](https://codecov.io/gh/lefticus/my_awesome_game)
5+
[![CodeQL](https://github.com/lefticus/my_awesome_game/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/lefticus/my_awesome_game/actions/workflows/codeql-analysis.yml)
76

8-
## About ftxui_template
7+
LGTM Has to be set up manually after template is created:
98

10-
This is a C++ Best Practices GitHub template for getting up and running with C++ quickly.
9+
[![Language grade: C++](https://img.shields.io/lgtm/grade/cpp/github/lefticus/my_awesome_game)](https://lgtm.com/projects/g/lefticus/my_awesome_game/context:cpp)
1110

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
1313

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
5014

5115
## More Details
5216

5317
* [Dependency Setup](README_dependencies.md)
5418
* [Building Details](README_building.md)
5519
* [Troubleshooting](README_troubleshooting.md)
5620
* [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

Comments
 (0)