Skip to content

Commit af803b9

Browse files
authored
docs: enhance README.md with key features and usage (#82)
* docs(readme): add `Usage` section * docs(readme): add `Key Features` section * docs(readme): add version and license badges
1 parent 71dc7f5 commit af803b9

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
# C++ Starter
22

3+
[![version](https://img.shields.io/github/v/release/threeal/cpp-starter?style=flat-square)](https://github.com/threeal/cpp-starter/releases)
4+
[![license](https://img.shields.io/github/license/threeal/cpp-starter?style=flat-square)](./LICENSE)
35
[![build status](https://img.shields.io/github/actions/workflow/status/threeal/cpp-starter/build.yaml?branch=main&style=flat-square)](https://github.com/threeal/cpp-starter/actions/workflows/build.yaml)
46
[![test status](https://img.shields.io/github/actions/workflow/status/threeal/cpp-starter/test.yaml?branch=main&label=test&style=flat-square)](https://github.com/threeal/cpp-starter/actions/workflows/test.yaml)
57

68
The C++ Starter is a [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that provides a minimalistic boilerplate to kickstart your [C++](https://isocpp.org) project. This template offers a streamlined foundation, complete with predefined file structures, essential tools, and recommended settings, ensuring a swift and efficient start to your C++ development journey.
9+
10+
## Key Features
11+
12+
- Utilizes [CMake](https://cmake.org/) as the build system generator.
13+
- Integrates [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake/) for efficient package management.
14+
- Incorporates [Catch2](https://github.com/catchorg/Catch2) as the testing framework.
15+
- Enforces consistent code formatting through [Format.cmake](https://github.com/TheLartians/Format.cmake).
16+
- Implements static analysis by enabling warnings using [CheckWarning.cmake](https://github.com/threeal/CheckWarning.cmake/).
17+
- Comes with a preconfigured [GitHub Actions](https://github.com/features/actions) workflow for continuous integration.
18+
- Supports automatic dependency updates through [Dependabot](https://docs.github.com/en/code-security/dependabot) in GitHub Actions.
19+
20+
## Usage
21+
22+
Refer to [this wiki](https://github.com/threeal/cpp-starter/wiki) for information on how to use this template.

0 commit comments

Comments
 (0)