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 <[email protected]> * Update README.md Co-authored-by: Lars Melchior <[email protected]> Co-authored-by: Lars Melchior <[email protected]>
TheLartians · Feb 19, 2021 · 573663d · 573663d
1 parent 2db60f2
commit 573663d
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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`