From c3d616c90b38c42b02211b1fdcf3cdc07fc29eb3 Mon Sep 17 00:00:00 2001 From: CJSatnarine Date: Wed, 24 Jul 2024 03:11:58 -0400 Subject: [PATCH] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e818c47..6a0f5b0 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ The output of this programme is a [PPM file](https://en.wikipedia.org/wiki/Netpb # :hammer_and_wrench: Building and Running the Code To run this code, you'll need to build it as it uses CMake. To build it, go to the root directory in the terminal and run the commands: -`cmake -B build` +- `cmake -B build` -`cmake --build build` +- `cmake --build build` >The `cmake --build build` command should be run whenever a change is made to the `CMakeLists.txt` file in the build directory. @@ -25,19 +25,19 @@ To run the code, you run the command: This build option is to render faster. For **Windows**, run this command to optimised build: -`cmake --build build --config release` +- `cmake --build build --config release` And to run the build: -`build\Release\Raytracer.exe > image.ppm` +- `build\Release\Raytracer.exe > image.ppm` For **Mac** or **Linux**, run these commands to obptimise build for the fastest results: -`cmake -B build/Release -DCMAKE_BUILD_TYPE=Release` +- `cmake -B build/Release -DCMAKE_BUILD_TYPE=Release` -`cmake --build build/Release` +- `cmake --build build/Release` And to run the build: -`build/Release/Raytracer > image.ppm` +- `build/Release/Raytracer > image.ppm` You'll need an image viewer to view the PPM file. I used [feh](https://feh.finalrewind.org/).