Skip to content

Commit

Permalink
[README] Update running instructions
Browse files Browse the repository at this point in the history
Brought the running instructions to be in-sync with the new
build instructions. Also address review comments on #1437 by @rupsis
  • Loading branch information
armansito authored and hollasch committed Apr 7, 2024
1 parent 0ee56b6 commit 6ff4b4a
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 6ff4b4a

Please sign in to comment.