Added readme

1 files changed, 39 insertions, 0 deletions

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
+```