From 6ff4b4a9958c5d0d210729c658185f6478cd261a Mon Sep 17 00:00:00 2001 From: Arman Uguray Date: Sun, 7 Apr 2024 15:59:00 -0700 Subject: [PATCH] [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 --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 42a9b767..c21f8abb 100644 --- a/README.md +++ b/README.md @@ -154,8 +154,8 @@ On Windows: ```shell $ cmake -B build -$ cmake --build build --config Release # Create release binaries in `build/Release` -$ cmake --build build --config Debug # Create debug binaries in `build/Debug` +$ cmake --build build --config Release # Create release binaries in `build\Release` +$ cmake --build build --config Debug # Create debug binaries in `build\Debug` ``` On Linux / macOS: @@ -171,7 +171,8 @@ $ cmake --build build/Debug ``` We recommend building and running the `Release` version (especially before the final render) for -the fastest results, unless you need extra debugging information of the (default) debug build. +the fastest results, unless you need the extra debug information provided by the (default) debug +build. ### CMake GUI on Windows 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. ### Running The Programs -On Linux or OSX, from the terminal, run like this: +You can run the programs by executing the binaries placed in the build directory: - $ build/inOneWeekend > image.ppm + $ build\Debug\inOneWeekend > image.ppm -On Windows, run like this: +or, run the optimized version (if you compiled with the release configuration): - build\debug\inOneWeekend > image.ppm - -or, run the optimized version (if you've built with `--config release`): - - build\release\inOneWeekend > image.ppm + $ build\Release\inOneWeekend > image.ppm The generated PPM file can be viewed directly as a regular computer image, if your operating system supports this image type. If your system doesn't handle PPM files, then you should be able to find