docs: Configure README file
This commit is contained in:
parent
7976110c27
commit
459cec7ae5
42
README.md
42
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)
|
[![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
|
## Build
|
||||||
For building, type `make` and enter the directory `build`. After that, just type `./editor` to run the 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**
|
* **GLFW**
|
||||||
* **ImGUI**
|
* **GLAD**
|
||||||
|
* **GLM**
|
||||||
|
* **ImGUI*
|
||||||
|
Loading…
Reference in New Issue
Block a user