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

docs: Add shell file instructions and seperate building options

Browse Source
This commit is contained in:
Huseyn Ismayilov 2024-11-22 17:49:55 +04:00
parent 5ad68f110e
commit 6ede914092
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/Building Project.md
View File

@ -10,18 +10,36 @@ After clonning the repo, update the submodules:
git submodule update --init 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 ## Commands
### Makefile
Here is the list of each `make` command: Here is the list of each `make` command:
`make` - builds the project and runs it (default: debug)<br> `make` - builds the project and runs it (default: debug)<br>
`make debug` - builds the project as debug<br> `make build-debug` - builds the project as debug<br>
`make release` - builds the project as release<br> `make build-release` - builds the project as release<br>
`make run` - runs the executable<br> `make run-debug` - runs the executable of debug<br>
`make clean` - cleans the build target<br> `make run-release` - runs the executable of release<br>
`make clean-all` - deletes build directory<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 ## Dependencies