-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
388c802
commit fb53baa
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# ray-tracing | ||
|
||
A raytracing project created for the purpose of learning | ||
|
||
## Downloading and Building the Project | ||
|
||
This project can be downloaded by using the | ||
``` | ||
git clone --recurse-submodules https://github.com/abdelrahim-hentabli/ray-tracing.git | ||
``` | ||
or | ||
``` | ||
git clone --recurse-submodules [email protected]:abdelrahim-hentabli/ray-tracing.git | ||
``` | ||
|
||
|
||
The library/executables can be built by calling (from within the project directory): | ||
``` | ||
mkdir build && cd build | ||
cmake -DCMAKE_BUILD_TYPE=Release .. | ||
cmake --build . --parallel <# of cores available for build> | ||
``` | ||
|
||
### Running the tests/benchmarks | ||
|
||
Tests can be run by calling the executable at | ||
``` | ||
./build/tools/test/tests | ||
``` | ||
|
||
And benchmarks can be run by calling | ||
``` | ||
./build/tools/benchmark/benchmarks | ||
``` |