schtobia/ModernCppStarter
1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-10-31 02:01:33 +01:00
Code Issues Activity

update readme

Browse source
This commit is contained in:
Lars Melchior 2020-04-14 13:39:14 +02:00
parent 500d028c8f
commit 93d0fe795c
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -15,7 +15,8 @@ This template is a collection from learnings of previous projects and should all
## Features
- Modern CMake practices
- Suited for single header libraries and larger projects
- Suited for single header libraries and projects of any scale
- Separation into library and executable code
- Integrated test suite
- Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)
- Code coverage via [codecov](https://codecov.io)
@ -27,12 +28,14 @@ This template is a collection from learnings of previous projects and should all
### Adjust the template to your needs
- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) and replace all occurrences of "Greeter" in [both](test/CMakeLists.txt) [CMakeLists.txt](CMakeLists.txt) with the name of your project
- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) and replace all occurrences of "Greeter" in the relevant CMakeLists.txt with the name of your project
- Replace the source files with your own
- For single-header libraries: see the comments in [CMakeLists.txt](CMakeLists.txt)
- Add your project's codecov token to your project's github secrets under `CODECOV_TOKEN`
- Happy coding!
Remember to eventually remove any unused files, such as the standalone directory or irrelevant tests for your project.
### Build and run the standalone target
Use the following command to build and run the executable target.