From 459cec7ae5b5539175e32f01aae3c22bd800c764 Mon Sep 17 00:00:00 2001
From: Huseyn Ismayilov <coderloff@gmail.com>
Date: Mon, 29 Jul 2024 16:26:40 +0400
Subject: [PATCH] docs: Configure README file

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++------
 1 file changed, 36 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index baed217..5c6e125 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,41 @@
-# Ferx - A basic game engine written in c++
+# Ferx
+
+Ferx is a basic game engine written in c++
 
 [![CMake on a single platform](https://github.com/coderloff/ferx/actions/workflows/cmake-single-platform.yml/badge.svg)](https://github.com/coderloff/ferx/actions/workflows/cmake-single-platform.yml)
 
-## 🛠️ Build
-For building, type `make` and enter the directory `build`. After that, just type `./editor` to run the build
+## Build
+
+To clone repo:
+```bash
+git clone https://github.com/coderloff/learnopengl
+```
+
+After clonning the repo, update the submodules:
+```bash
+git submodule update --init
+```
+
+That's it! You can build and run the project with `make` command
+
+### Commands
+
+Here is the list of each `make` command:
+
+`make` - builds the project and runs it (default: debug)<br>
+`make debug` - builds the project as debug<br>
+`make release` - builds the project as release<br>
+`make run` - runs the executable<br>
+`make clean` - cleans the build target<br>
+`make clean-all` - deletes build directory<br>
+
+## Dependencies
+
+Required dependencies: git cmake make ninja
+
+## Libraries
 
-## 📦 Dependencies
-* **GLAD**
 * **GLFW**
-* **ImGUI**
+* **GLAD**
+* **GLM**
+* **ImGUI*