diff --git a/README.md b/README.md index bd7921334574043c0637631444cd808f1f93b60a..a8c6ded4aa71e613387e29e7beaa35498c2d0f96 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)