Skip to content

Commit c1a196c

Browse files
author
Pedro Soares
committed
docs: update README.md with build dir instructions
If one wants to build the project without using a build dir, it will fail. Thus, adding the instructions to warn about it on Command Line instructions section. Also, improved the documentation on how to configure cmake to use Release configuration and install public outputs.
1 parent f1312b1 commit c1a196c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,13 +172,14 @@ change the config from `Debug` (default) to `Release`, use another build tool li
172172
to install the dependencies, remember to specify the `-DCMAKE_TOOLCHAIN_FILE=...` option when you run the initial build
173173
configuration.
174174

175-
- Configure the build system: `"cmake ."`
175+
- Create a build directory: `"mkdir build && cd build"`
176+
- Configure the build system: `"cmake .."`
176177
- Tell CMake to invoke the build system: `"cmake --build ."` _You can repeat this step to rebuild your changes._
177178
- CTest comes with CMake and runs the tests: `"ctest ."` _Run this frequently, and make sure it passes before commits._
178179

179-
You can then optionally install the public outputs by running.
180-
181-
- `cmake --build . --config Release --target install` _You probably need to use `sudo` on Unix to do this._
180+
You can then optionally install the public outputs by configuring it with `Release`:
181+
- `cmake -DCMAKE_BUILD_TYPE=Release ..`
182+
- `cmake --build . --target install` _You probably need to use `sudo` on Unix to do this._
182183

183184
## Interactive tests
184185

0 commit comments

Comments
 (0)