From af9e9bb39b14f022bd7b3f57a3d506b0551c0971 Mon Sep 17 00:00:00 2001
From: Benedikt Ziemons <ben@rs485.network>
Date: Wed, 1 Jun 2022 10:26:53 +0200
Subject: [PATCH] First commit

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..365e3ae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Raytracer for Advanced Computer Graphics
+
+Depdendencies:
+- Qt6
+  (untested with Qt5, needs CMakeLists.txt adjustments)
+- OBJ Loader (included, see `thirdparty` directory)
+- Utah Teapot (included, see `newell_teaset`, Source: https://www.cs.utah.edu/~natevm/newell_teaset/newell_teaset.zip)
+
+Features:
+- Material features: Phong lighting, reflections, transparency
+- Accelerated Raytracing on triangles using a KD-Tree structure
+- Raytracing with *planes*, *spheres* and *triangles*
+- A ton of work
+
+
+## Compiling
+
+```shell
+cmake -B build
+```
+
+## Running
+
+```shell
+build/RaytryCpp
+```
+
+*Note: Teapot must be provided in working directory under **newell_teaset/teapot.obj**.*