From 82decb93fc7229792962749d11dcadb38e22bbcf Mon Sep 17 00:00:00 2001 From: Evili del Rio i Silvan <erio@iri.upc.edu> Date: Fri, 17 Jun 2016 14:21:13 +0200 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3e5decd..73fe53c 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. -- GitLab