generated from embedded-dev-research/cpp-project-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,5 @@ | ||
<!-- Modify README.md file in the actual repository for your needs --> | ||
[![Build application](https://github.com/embedded-dev-research/itlab_2024/actions/workflows/main.yml/badge.svg)](https://github.com/embedded-dev-research/itlab_2024/actions/workflows/main.yml) | ||
[![Static analysis](https://github.com/embedded-dev-research/itlab_2024/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/embedded-dev-research/itlab_2024/actions/workflows/static-analysis.yml) | ||
[![CodeQL](https://github.com/embedded-dev-research/itlab_2024/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/embedded-dev-research/itlab_2024/actions/workflows/codeql-analysis.yml) | ||
|
||
[![Build application](https://github.com/aobolensk/cpp-project-template/actions/workflows/main.yml/badge.svg)](https://github.com/aobolensk/cpp-project-template/actions/workflows/main.yml) | ||
[![Static analysis](https://github.com/aobolensk/cpp-project-template/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/aobolensk/cpp-project-template/actions/workflows/static-analysis.yml) | ||
[![CodeQL](https://github.com/aobolensk/cpp-project-template/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/aobolensk/cpp-project-template/actions/workflows/codeql-analysis.yml) | ||
|
||
|
||
# C++ project template | ||
|
||
This template is designed for quick start of C++ project. | ||
|
||
## Build | ||
|
||
```bash | ||
$ git clone https://github.com/aobolensk/cpp-project-template --recusive | ||
$ cd cpp-project-template | ||
$ cmake -S . -B build | ||
$ cmake --build build --parallel | ||
``` | ||
|
||
## Test | ||
|
||
```bash | ||
$ build/bin/run_tests | ||
``` | ||
|
||
## Code coverage | ||
|
||
This project offers two methods to view code coverage: | ||
|
||
* HTML artifacts with code test coverage details are available on each commit | ||
* To configure [codecov.io](codecov.io) follow the official documentation. Token secrets: `CODECOV_TOKEN` | ||
# itlab_2024 |