Append .zip to ZIP files generated by release script

[dragonblocks_alpha.git] / BUILDING.md

diff --git a/BUILDING.md b/BUILDING.md
index 6bf62f500b2a422495ef6194d1f350c60534b936..40ba5f4ac0e42c2aa13ffe4ae25fca03d873848b 100644 (file)
--- 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.