Skip to content

Commit 153de8f

Browse files
committed
docs: re-enable badges for gh actions linux and codecov
1 parent a84d985 commit 153de8f

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,31 @@ cross-platform c++ application for Linux, OSX, and Windows x64. Triggers the CI
55
to build and run the tests, and run coverage. Uses conan to install
66
dependencies: Catch2 for testing, and fmt. Format with clang-format
77

8+
## Requirements
9+
10+
- CMake > 3.24
11+
- A C++23 compliant compiler
12+
- Conan 2.x
13+
14+
15+
## Build Status
16+
817
| System | App | Status |
918
|----------|------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1019
| Linux | GH Actions | [![linux](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/linux.yml/badge.svg?branch=main)](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/linux.yml) |
11-
| OSX | GH Actions | [![macos](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/macosx.yml/badge.svg)](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/macosx.yml) |
12-
| Win x64 | GH Actions | [![windows](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/windows.yml/badge.svg)](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/windows.yml) |
1320

14-
[//]: # (| Coverage | codecov | [![codecov](https://codecov.io/gh/spjuanjoc/template_project_cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/spjuanjoc/template_project_cpp) |)
21+
[//]: # (| OSX | GH Actions | [![macos](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/macosx.yml/badge.svg)](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/macosx.yml) |)
22+
[//]: # (| Win x64 | GH Actions | [![windows](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/windows.yml/badge.svg)](https://github.com/spjuanjoc/template_project_cpp/actions/workflows/windows.yml) |)
1523

16-
[//]: # (| Windows | AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/kkg8iaq74wql90rj/branch/main?svg=true)](https://ci.appveyor.com/project/spjuanjoc/template-project-cpp/branch/main) |)
1724

18-
[//]: # (For codecov add public repository: [Codecov Dashboard](https://codecov.io/gh/) )
25+
## Code Coverage
1926

20-
[//]: # (For AppVeyor add public project: [AppVeyor Projects](https://ci.appveyor.com/project) )
27+
| System | App | Status |
28+
|----------|------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
29+
| Coverage | codecov | [![codecov](https://codecov.io/gh/spjuanjoc/template_project_cpp/branch/main/graph/badge.svg)](https://codecov.io/gh/spjuanjoc/template_project_cpp) |
2130

2231

23-
## Requirements
24-
25-
- CMake > 3.24
26-
- A C++20 compliant compiler
32+
For codecov add public repository: [Codecov Dashboard](https://codecov.io/gh/)
2733

2834

2935
## Build
@@ -32,7 +38,7 @@ Build in debug mode with tests:
3238

3339
```shell
3440
mkdir build && cd build
35-
cmake .. -DENABLE_TESTS=True -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=/path/to/cmake/conan_provider.cmake -DCMAKE_BUILD_TYPE=Debug
41+
cmake .. -DENABLE_TESTS=True -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=/abs/path/to/cmake/conan_provider.cmake -DCMAKE_BUILD_TYPE=Debug
3642
cmake --build .
3743
```
3844

0 commit comments

Comments
 (0)