X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=BUILDING.md;h=40ba5f4ac0e42c2aa13ffe4ae25fca03d873848b;hb=a19b87004a71d200cc8baf33056505c4f737e2eb;hp=ad558df108fd3f139ad038b3d2129da142adadff;hpb=1d815b7249d3b53baea2a6a6ffa6e7acdd7d04da;p=dragonblocks_alpha.git diff --git a/BUILDING.md b/BUILDING.md index ad558df..40ba5f4 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,6 +1,22 @@ # Building instructions -The code and the Makefile are located in the src/ directory +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) @@ -9,9 +25,9 @@ The code and the Makefile are located in the src/ directory - `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 ./release.sh ```