In Linux distributions you can open your terminal and execute the commands below.(every distrubution may need some change for the package manager and permission)
you will need the gcc compilation suite, using Linux distro you can use:
Debian:
sudo apt install build-essential
this will download the basic suit in order to build the project
Also install:
sudo apt install make
if you are using Linux distrubution you can install the following packages with the command below:
Debian:
sudo apt install libglfw3-dev libglfw3 libassimp-dev libstb-dev libstb0 libglm-dev libglew-dev libglew2.2
your also going to need the mold linker:
sudo apt install mold
The same librarys can be found in windows using MSYS. Using visual studio is not supported by default, althought the setup is not difficult.
In order to compile, you will need Make in order to build from the makefile
For compilation you will need certain librarys in order to work:
Working on some futures in order to reduce needed librarys to link.
First run the setup using
make Setup
You will also need to run the setup for DEBUG=0 with the following command
make Setup DEBUG=0
In order to build the project after installing all the necessary librarys, you run the following command:
make
If you only need to build the project you can run:
make Build or make Build -j for multicompilation.
make Build DEBUG=0 or make Build -j DEBUG=0 for release build
if you only need to run the executable then type:
make Run or make Run DEBUG=0 to run either debug or release build
you can use clang compiler if you have it installed in your system
make Build USE_CLANG=1
You can generate documentation for the project using doxygen:
Debian:
sudo apt install doxygen
to execute:
doxygen doxygen-config
you can find the generated html in: DOCS/html/index.html of the project directory.