Skip to content

Commit

Permalink
added readme (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
abdelrahim-hentabli authored Feb 12, 2024
1 parent 388c802 commit fb53baa
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
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
```

0 comments on commit fb53baa

Please sign in to comment.