schtobia/MyModernCppStarter
1
0
Fork 0
Code Issues Pull requests Activity

add coverage info to readme

Browse source
This commit is contained in:
Lars Melchior 2020-04-13 17:59:53 +02:00
parent e9f7defe05
commit ab114c5408
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -17,9 +17,9 @@ This template is a collection from learnings of previous projects and should all
- Modern CMake practices - Modern CMake practices
- Suited for single header libraries and larger projects - Suited for single header libraries and larger projects
- Integrated test suite - Integrated test suite
- Continuous integration via GitHub Workflows - Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)
- Code coverage via codecov - Code coverage via [codecov](https://codecov.io)
- Code formatting enforced via [clang-format](https://clang.llvm.org/docs/ClangFormat.html) / [Format.cmake](https://github.com/TheLartians/Format.cmake) - Code formatting enforced by [clang-format](https://clang.llvm.org/docs/ClangFormat.html) via [Format.cmake](https://github.com/TheLartians/Format.cmake)
- Reproducible dependency management via [CPM.cmake](https://github.com/TheLartians/CPM.cmake) - Reproducible dependency management via [CPM.cmake](https://github.com/TheLartians/CPM.cmake)
## Usage ## Usage
@ -29,6 +29,7 @@ This template is a collection from learnings of previous projects and should all
- Clone this repo and replace all occurrences of "Greeter" in the [CMakeLists.txt](CMakeLists.txt) with the name of your project - Clone this repo and replace all occurrences of "Greeter" in the [CMakeLists.txt](CMakeLists.txt) with the name of your project
- Replace the source files with your own - Replace the source files with your own
- For single-header libraries: see the comments in [CMakeLists.txt](CMakeLists.txt) - For single-header libraries: see the comments in [CMakeLists.txt](CMakeLists.txt)
- Replace the codecov token in the [ubuntu workflow](.github/workflows/ubuntu.yml) or remove the codecov step
- Happy coding! - Happy coding!
### Build and run test suite ### Build and run test suite