Update README.md
This commit is contained in:
@@ -1,7 +0,0 @@
|
||||
# About
|
||||
This is a project where I learn how a raytracer works by building one. To accomplish this, I will be following along a few books, in particular the *Ray Tracing in One Weekend* series.
|
||||
|
||||
### Resources Used
|
||||
[_Ray Tracing in One Weekend_](https://raytracing.github.io/books/RayTracingInOneWeekend.html)
|
||||
|
||||
[_Ray Tracing: The Next Week_](https://raytracing.github.io/books/RayTracingTheNextWeek.html)
|
49
README/README.md
Normal file
49
README/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# :question: About
|
||||
This is a project where I learn how a raytracer works by building one. To accomplish this, I will be following along a few books, in particular the [*Ray Tracing in One Weekend*](https://raytracing.github.io/) series.
|
||||
|
||||
The output of this programme is a [PPM file](https://en.wikipedia.org/wiki/Netpbm#File_formats) that contains the rendered image.
|
||||
|
||||
# :camera_flash: Screenshots
|
||||

|
||||

|
||||
|
||||
|
||||
# :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 --build build`
|
||||
|
||||
>The `cmake --build build` command should be run whenever a change is made to the `CMakeLists.txt` file in the build directory.
|
||||
|
||||
To run the code, you run the command:
|
||||
- **Windows**: `build\Debug\Raytracer.exe > image.ppm`
|
||||
- **Mac and Linux**: `build/Raytracer > image.ppm`
|
||||
|
||||
## Optimised Builds
|
||||
This build option is to render faster.
|
||||
|
||||
For **Windows**, run this command to optimised build:
|
||||
`cmake --build build --config release`
|
||||
|
||||
And to run the build:
|
||||
`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 --build build/Release`
|
||||
|
||||
And to run the build:
|
||||
`build/Release/Raytracer > image.ppm`
|
||||
|
||||
You'll need an image viewer to view the PPM file. I used [feh](https://feh.finalrewind.org/).
|
||||
|
||||
# :scroll: To Do
|
||||
A list of things I wish to implement:
|
||||
- [ ] Triangles
|
||||
|
||||
|
||||
# :book: Resources Used
|
||||
[_Ray Tracing in One Weekend_](https://raytracing.github.io/books/RayTracingInOneWeekend.html)
|
||||
|
||||
[_Ray Tracing: The Next Week_](https://raytracing.github.io/books/RayTracingTheNextWeek.html)
|
BIN
README/bouncingSpheres.png
Normal file
BIN
README/bouncingSpheres.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 386 KiB |
BIN
README/cornellBox.png
Normal file
BIN
README/cornellBox.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 685 KiB |
Reference in New Issue
Block a user