aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..60d7f74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# realtime-raytracing-demo
+
+A hardware-accelerated (via OpenGL) realtime raytracer written in C/GLSL.
+Move with W/A/S/D and the mouse.
+Supports spheres as a shape primitive and three materials: An ideal lambertian diffuse, metal (with adjustable diffuse), and dielectric (glass-like).
+
+## building
+
+GLFW requires X11 development headers to build. Should build on other platforms too, but I haven't tested it.
+
+```
+mkdir build
+cd build
+cmake .. && make && ./realtime-raytracing-demo
+``` \ No newline at end of file