X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=BUILDING.md;h=40ba5f4ac0e42c2aa13ffe4ae25fca03d873848b;hb=a19b87004a71d200cc8baf33056505c4f737e2eb;hp=6bf62f500b2a422495ef6194d1f350c60534b936;hpb=da66a867f706aacf843007d3cf309b7df1d54d66;p=dragonblocks_alpha.git diff --git a/BUILDING.md b/BUILDING.md index 6bf62f5..40ba5f4 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,5 +1,23 @@ # Building instructions +GNU make is used for compiling. The code and the Makefile are located in the src/ directory. + +## Dependencies +To build anything you need g++ and GNU make. +```bash +sudo apt install build-essential make +``` + +The development versions OpenGL, GLFW3, GLEW are required to build the client. +```bash +sudo apt install libgl1-mesa-dev libglfw3-dev libglew-dev +``` + +Don't forget to pull the submodules before building. +``bash +git submodule update --init +``` + ## Available targets - `all` (default) - `Dragonblocks` @@ -7,9 +25,10 @@ - `clean` - `clobber` -Debug flag (`-g`) is set by default. +The debug flag (`-g`) is set by default (RELEASE=TRUE will disable it). -## Release Build +## Release ```bash -make clobber && make all RELEASE=TRUE -j$(nproc) && make clean +./release.sh ``` +This script will create a release zipfile.