1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-08-30 21:51:12 +02:00

Add note to README to update workflow triggers

This was an oversight on my part that I would suspect others might run into - I used the template and pushed to a main branch, and totally missed the fact that none of the workflows were running. When it was time to properly add tests I realized that the files were there, and I simply needed to update the branch from master to main. So that others don't run into this issue, I am suggesting adding a line in the README to alert the reader to do the change.
This commit is contained in:
Vanessasaurus 2021-06-05 13:10:18 -06:00 committed by GitHub
parent acab9a3b78
commit 5f1ea9e770
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -39,6 +39,7 @@ This template is the result of learnings from many previous projects and should
- Replace the source files with your own
- For header-only libraries: see the comments in [CMakeLists.txt](CMakeLists.txt)
- Add [your project's codecov token](https://docs.codecov.io/docs/quick-start) to your project's github secrets under `CODECOV_TOKEN`
- Update the branch triggers in the [.github/workflows](.github/workflows) to be your main branch (the default is "master" and if your main branch is "main" the workflows will not trigger)
- Happy coding!
Eventually, you can remove any unused files, such as the standalone directory or irrelevant github workflows for your project.