diff --git a/README.md b/README.md index 3e5decdc6b451c35a0c8468c8949b738dde6cc0e..73fe53c5ff36ea60099e74b2d73f52bc7c1b3245 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,12 @@ This is a toy CMake project to start using GitLab and CI with GoogleTest, valgrind, and coverage ready to use. -Just copy (or clone) the contents of this repo and then: - -* Edit CMakeLists.txt and src/CMakeLists.txt to your taste. -* Edit/replace src/main.cpp. -* Remove dummy source files like src/SomeHeader.h, tests/silly_test.cpp, etc. - +The project is organized with three directories: +* `src`, where you should put all your code. +* `tests`, where you should put all the testing code. +* `ext`, where you should import any external project/library (like GoogleTest). +To use it, just copy (or clone) the contents of this repo and then: +* Edit `CMakeLists.txt` and `src/CMakeLists.txt` to your taste. +* Edit/replace `src/main.cpp`. +* Remove dummy source files like `src/SomeHeader.h`, `tests/silly_test.cpp`, etc.