TheZone/ferx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #20 from coderloff/main

Browse Source 
docs: Update docs
This commit is contained in:
Huseyn Ismayilov 2024-11-22 17:56:47 +04:00 committed by GitHub
commit 21bf477624
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,6 @@
# Ferx Engine
![Ferx](https://raw.githubusercontent.com/coderloff/ferx/refs/heads/main/docs/assets/Ferx.png)
![Ferx](docs/assets/Ferx.png)
<div align="center">
<img src="https://img.shields.io/github/actions/workflow/status/coderloff/ferx/cmake-single-platform.yml?style=for-the-badge" alt="Build" />
@ -11,4 +11,6 @@
<img src="https://img.shields.io/github/issues/coderloff/ferx?style=for-the-badge" alt="Issues" />
</div>
Ferx is a basic game engine written in C++. This project is mainly designed for learning purposes. For more information, check out [docs](https://github.com/coderloff/ferx/)
<br>
Ferx is a basic game engine written in C++. This project is mainly designed for learning purposes. For more information, check out [docs](docs)

30
docs/Building Project.md
View File

@ -10,18 +10,36 @@ After clonning the repo, update the submodules:
git submodule update --init
```
That's it! You can build and run the project with `make` command
That's it! You can build and run the project by entering `scripts` directory and using `make` command or `BuildProject.sh` file.
## Commands
### Makefile
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>
`make build-debug` - builds the project as debug<br>
`make build-release` - builds the project as release<br>
`make run-debug` - runs the executable of debug<br>
`make run-release` - runs the executable of release<br>
`make clean-debug` - cleans the build target of debug<br>
`make clean-release` - cleans the build target of release<br>
`make clean-debug-all` - deletes debug build directory<br>
`make clean-release-all` - deletes release build directory<br>
### Shell file
Here is the list of each `BuildProject.sh` command:
`./BuildProject.sh all` - builds the project and runs it (default: debug)<br>
`./BuildProject.sh build-debug` - builds the project as debug<br>
`./BuildProject.sh build-release` - builds the project as release<br>
`./BuildProject.sh run-debug` - runs the executable of debug<br>
`./BuildProject.sh run-release` - runs the executable of release<br>
`./BuildProject.sh clean-debug` - cleans the build target of debug<br>
`./BuildProject.sh clean-release` - cleans the build target of release<br>
`./BuildProject.sh clean-debug-all` - deletes debug build directory<br>
`./BuildProject.sh clean-release-all` - deletes release build directory<br>
## Dependencies