Skip to content

Commit

Permalink
Cleanup template and initialize repository
Browse files Browse the repository at this point in the history
  • Loading branch information
Template Janitor committed Mar 23, 2022
1 parent 26df903 commit 4c026ad
Show file tree
Hide file tree
Showing 11 changed files with 17 additions and 348 deletions.
4 changes: 0 additions & 4 deletions .github/FUNDING.yml

This file was deleted.

20 changes: 0 additions & 20 deletions .github/template/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions .github/template/removal-list

This file was deleted.

1 change: 0 additions & 1 deletion .github/template/template_name

This file was deleted.

1 change: 0 additions & 1 deletion .github/template/template_repository

This file was deleted.

233 changes: 0 additions & 233 deletions .github/workflows/template-janitor.yml

This file was deleted.

4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ include(${_project_options_SOURCE_DIR}/Index.cmake)

# Set the project name and language
project(
myproject
my_awesome_game
VERSION 0.0.1
DESCRIPTION ""
HOMEPAGE_URL "%%myurl%%"
HOMEPAGE_URL "https://github.com/lefticus/my_awesome_game"
LANGUAGES CXX C)

set(GIT_SHA
Expand Down
24 changes: 0 additions & 24 deletions LICENSE

This file was deleted.

62 changes: 8 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,20 @@
# ftxui_template
# my_awesome_game

[![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)
[![codecov](https://codecov.io/gh/cpp-best-practices/ftxui_template/branch/main/graph/badge.svg)](https://codecov.io/gh/cpp-best-practices/ftxui_template)
[![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)
[![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)
[![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)
[![codecov](https://codecov.io/gh/lefticus/my_awesome_game/branch/main/graph/badge.svg)](https://codecov.io/gh/lefticus/my_awesome_game)
[![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)

## About ftxui_template
LGTM Has to be set up manually after template is created:

This is a C++ Best Practices GitHub template for getting up and running with C++ quickly.
[![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)

By default (collectively known as `ENABLE_DEVELOPER_MODE`)
## About my_awesome_game
This is an awesome submission to the C++ Best Practices Game Jam

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

It includes

* a basic CLI example
* examples for fuzz, unit, and constexpr testing
* large github action testing matrix

It requires

* cmake
* conan
* 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/ftxui_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 commited 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)


Loading

0 comments on commit 4c026ad

Please sign in to comment.