From 4416740531c1747af699296f5dec972e1f390632 Mon Sep 17 00:00:00 2001
From: Weckyy702 <50154363+Weckyy702@users.noreply.github.com>
Date: Sat, 12 Feb 2022 17:35:12 +0100
Subject: [PATCH] README: update README.md

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 56 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 124b641..63ae767 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
-# Raychel
-Raymarching Engine written in standard C++20
+# Raychel - Raymarching Engine written in standard C++20
+
+## What is ray marching?
+
+In ray marching, every object is defined by a so called **signed distance funtion**, SDF for short. A SDF gives the distance between a point in space and a surface, with negative values meaning the point is inside the object.  
+To trace a ray in a certain direction, we can take the minimum of all SDFs in the scene and move by that amount in that direction. We can now repeat this process until the smallest distance is zero (or very close to it).  
+Like all ray tracing algorithms, ray marching allows for very realistic lighting simulations.
+
+## Features
+
+The engine is currently a WIP and new features are added with almost every commit.  
+Current features include:
+* Nothing yet :(
+
+## Language
+
+Raychel is written in standard C++20 using as little hacks as possible. The design style is rather functional than object oriented, although OO patterns are used.
+
+## Building
+
+### Compiler Support
+Raychel is primarily developed on a GNU/Linux system, so changes that break Windows compatibility may not be fixed immediately. The following compilers work for sure:
+* Clang 13
+* GCC 11
+
+### Dependencies / Library credit
+
+No dependency management is currently implemented, so you have to install the following libraries manually:
+* [RaychelLogger](https://github.com/Weckyy702/RaychelLogger)
+* [RaychelCore](https://github.com/Weckyy702/RaychelCore)
+* [RaychelMath](https://github.com/Weckyy702/RaychelMath)
+* [GSL](https://github.com/microsoft/GSL)
+* [Catch2](https://github.com/catchorg/Catch2) *only needed when building unit tests*
+
+### How to build
+
+After cloning the repository with
+
+    git clone https://github.com/Weckyy702/Raychel
+
+create the build directory using
+
+    mkdir build; cd build
+
+and run cmake:
+
+    cmake <your options> ..
+
+Lastly, build the library itself with
+
+    make
+
+<!--- If any errors occur, please check the [Wiki](https://github.com/Weckyy702/Raychel) TODO: add the wiki-->
+## I found a bug!!
+
+Nicely done! Please report it in the issues tab or open a pull request with your fix.