From 3b8893902ac5f529faf15accaa3fb5360771d3b3 Mon Sep 17 00:00:00 2001
From: Julian T <julian@jtle.dk>
Date: Tue, 11 Aug 2020 18:09:42 +0200
Subject: Added readme

---
 readme.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 readme.md

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..649a102
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,39 @@
+# Pathtracing
+
+## Build requirements
+
+- Catch2
+- Qt5
+
+## Building
+
+This is just standard cmake building.
+
+```
+mkdir build
+cd build
+cmake ../
+make
+```
+
+The program does currently not have any options, so just run it.
+
+```
+./pathtracing
+```
+
+
+## Testing
+
+To test the program follow the steps above but instead of `make` run `make test`.
+
+```
+make test
+```
+
+Then run the test executable.
+Remember to rerun `make test` when changing source files.
+
+```
+./run_test
+```
-- 
cgit v1.2.3