ferx/docs/Building Project.md

Building Project

To clone repo:

git clone https://github.com/coderloff/ferx

After clonning the repo, update the submodules:

git submodule update --init

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 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

Required dependencies: git, cmake, make, ninja