From 8645aca0b07d3bde55ab576eb3bc3c6f46fdb6b0 Mon Sep 17 00:00:00 2001
From: bobarna <barnabas.borcsok@gmail.com>
Date: Thu, 11 Mar 2021 13:45:06 +0100
Subject: [PATCH] updated readme

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bd79213..a8c6ded 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,47 @@
 # madid
 
 mad·​id (adjective) \ ˈmadə̇d \
-wet, moist
\ No newline at end of file
+wet, moist
+
+
+## Trying it out
+
+### Dependencies
+
+- GLM ([OpenGL Mathematics](https://github.com/g-truc/glm))
+- OpenGL
+    - [glew](https://github.com/nigels-com/glew)
+    - [glfw3](https://www.glfw.org/)
+- *optional: CMake*
+- a C++ compiler
+
+### Installing the dependencies
+
+*On Linux-based systems, with the apt package manager*
+
+``` bash
+sudo apt install libglm-dev libglew-dev libglfw3 cmake build-essential
+```
+
+### Compiling
+
+- create a build directory
+- build the program using cmake
+
+``` bash
+# from the project root directory
+mkdir build
+cd build
+cmake ..
+make
+```
+
+### Start the application
+
+``` bash
+./madid
+```
+
+## Contact
+Feel free to contact me at
+[barnabas.borcsok@gmail.com](barnabas.borcsok@gmail.com)
-- 
GitLab