Skip to content

Commit 322de73

Browse files
Update README.md
1 parent 65f3355 commit 322de73

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -1 +1,33 @@
11
# Raytracer
2+
3+
Simple C++ Raytracer parses [Wavefront](http://paulbourke.net/dataformats/obj/) format and uses the [Phong Reflection model](https://en.wikipedia.org/wiki/Phong_reflection_model) to render the scene.
4+
5+
## Supported features
6+
* Reflection / Refraction
7+
* Textures
8+
9+
## How to build
10+
1. Clone the project with submodules
11+
```
12+
git clone https://github.com/TolyaTalamanov/Raytracer
13+
git submodule update --init --recursive
14+
```
15+
2. Go to project folder and run CMake:
16+
```
17+
cd Raytracer && mkdir build
18+
cmake ../ -DCMAKE_BUILD_TYPE=Debug
19+
```
20+
3. Build with make:
21+
```
22+
make -j32
23+
```
24+
25+
### How to run
26+
1. Run the tests:
27+
```
28+
./bin/raytracer-tests
29+
```
30+
2. Run tool:
31+
```
32+
./bin/raytracer-tool <path-to-obj-file>
33+
```

0 commit comments

Comments
 (0)