diff --git a/README.md b/README.md index cf62170..7de9d43 100644 --- a/README.md +++ b/README.md @@ -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)
Build @@ -11,4 +11,6 @@ Issues
-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/) +
+ +Ferx is a basic game engine written in C++. This project is mainly designed for learning purposes. For more information, check out [docs](docs) diff --git a/docs/Building Project.md b/docs/Building Project.md index b13a8e8..f84181f 100644 --- a/docs/Building Project.md +++ b/docs/Building Project.md @@ -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)
-`make debug` - builds the project as debug
-`make release` - builds the project as release
-`make run` - runs the executable
-`make clean` - cleans the build target
-`make clean-all` - deletes build directory
+`make build-debug` - builds the project as debug
+`make build-release` - builds the project as release
+`make run-debug` - runs the executable of debug
+`make run-release` - runs the executable of release
+`make clean-debug` - cleans the build target of debug
+`make clean-release` - cleans the build target of release
+`make clean-debug-all` - deletes debug build directory
+`make clean-release-all` - deletes release build directory
+ +### Shell file +Here is the list of each `BuildProject.sh` command: + +`./BuildProject.sh all` - builds the project and runs it (default: debug)
+`./BuildProject.sh build-debug` - builds the project as debug
+`./BuildProject.sh build-release` - builds the project as release
+`./BuildProject.sh run-debug` - runs the executable of debug
+`./BuildProject.sh run-release` - runs the executable of release
+`./BuildProject.sh clean-debug` - cleans the build target of debug
+`./BuildProject.sh clean-release` - cleans the build target of release
+`./BuildProject.sh clean-debug-all` - deletes debug build directory
+`./BuildProject.sh clean-release-all` - deletes release build directory
+ ## Dependencies