From 573663dc15b60907873b441bea81cc7815beb752 Mon Sep 17 00:00:00 2001 From: nerrons Date: Fri, 19 Feb 2021 16:48:01 +0800 Subject: [PATCH] Update README.md about changing project name (#84) * Update README.md about changing project name * Update README.md * Update README.md Co-authored-by: Lars Melchior * Update README.md Co-authored-by: Lars Melchior Co-authored-by: Lars Melchior --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 500c5e55..4c9f20cf 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,10 @@ This template is the result of learnings from many previous projects and should ### 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 the relevant 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). +- Replace all occurrences of "Greeter" in the relevant CMakeLists.txt with the name of your project + - Capitalization matters here: `Greeter` means the name of the project, while `greeter` is used in file names. + - Remember to rename the `include/greeter` directory to use your project's lowercase name and update all relevant `#include`s accordingly. - 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`