https://github.com/lefticus/template_test_repository

This repository is used only for testing of the other templates
https://github.com/lefticus/template_test_repository

Last synced: 2 days ago
JSON representation

This repository is used only for testing of the other templates

• Host: GitHub
• URL: https://github.com/lefticus/template_test_repository
• Owner: lefticus
• License: unlicense
• Created: 2022-03-05T21:56:03.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-05T22:44:50.000Z (almost 3 years ago)
• Last Synced: 2024-11-05T16:56:34.386Z (about 2 months ago)
• Language: CMake
• Size: 691 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# cpp_boilerplate_project

[![ci](https://github.com/lefticus/template_test_repository/actions/workflows/ci.yml/badge.svg)](https://github.com/lefticus/template_test_repository/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/lefticus/template_test_repository/branch/main/graph/badge.svg)](https://codecov.io/gh/lefticus/template_test_repository)

[![Language grade: C++](https://img.shields.io/lgtm/grade/cpp/github/lefticus/template_test_repository)](https://lgtm.com/projects/g/cpp-best-practices/cpp_starter_project/context:cpp)

[![CodeQL](https://github.com/lefticus/template_test_repository/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/lefticus/template_test_repository/actions/workflows/codeql-analysis.yml)

## About cpp_boilerplate_project

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

 * 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

If you want a more complex example project, check out the [cpp_starter_project](https://github.com/cpp-best-practices/cpp_starter_project).

Ths Boilerplate project will merge new features first, then they will be merged (as appropriate) into cpp_starter_project.

## 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/lefticus/template_test_repository/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//.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)