Skip to content

Commit 6ff4b4a

Browse files
armansitohollasch
authored andcommitted
[README] Update running instructions
Brought the running instructions to be in-sync with the new build instructions. Also address review comments on #1437 by @rupsis
1 parent 0ee56b6 commit 6ff4b4a

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ On Windows:
154154

155155
```shell
156156
$ cmake -B build
157-
$ cmake --build build --config Release # Create release binaries in `build/Release`
158-
$ cmake --build build --config Debug # Create debug binaries in `build/Debug`
157+
$ cmake --build build --config Release # Create release binaries in `build\Release`
158+
$ cmake --build build --config Debug # Create debug binaries in `build\Debug`
159159
```
160160

161161
On Linux / macOS:
@@ -171,7 +171,8 @@ $ cmake --build build/Debug
171171
```
172172

173173
We recommend building and running the `Release` version (especially before the final render) for
174-
the fastest results, unless you need extra debugging information of the (default) debug build.
174+
the fastest results, unless you need the extra debug information provided by the (default) debug
175+
build.
175176

176177
### CMake GUI on Windows
177178
You may choose to use the CMake GUI when building on windows.
@@ -195,17 +196,13 @@ operating system to simply print the image to file.
195196

196197
### Running The Programs
197198

198-
On Linux or OSX, from the terminal, run like this:
199+
You can run the programs by executing the binaries placed in the build directory:
199200

200-
$ build/inOneWeekend > image.ppm
201+
$ build\Debug\inOneWeekend > image.ppm
201202

202-
On Windows, run like this:
203+
or, run the optimized version (if you compiled with the release configuration):
203204

204-
build\debug\inOneWeekend > image.ppm
205-
206-
or, run the optimized version (if you've built with `--config release`):
207-
208-
build\release\inOneWeekend > image.ppm
205+
$ build\Release\inOneWeekend > image.ppm
209206

210207
The generated PPM file can be viewed directly as a regular computer image, if your operating system
211208
supports this image type. If your system doesn't handle PPM files, then you should be able to find

0 commit comments

Comments
 (0)