]> git.lizzy.rs Git - dragonblocks_alpha.git/blobdiff - BUILDING.md
Correct acceleration calculation
[dragonblocks_alpha.git] / BUILDING.md
index ad558df108fd3f139ad038b3d2129da142adadff..cf02dc3bbbcc2961b44d7ed4a642509737660557 100644 (file)
@@ -1,6 +1,31 @@
 # 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 gcc and GNU make. The ZLib development library is needed as well.
+
+```bash
+sudo apt install build-essential make zlib1g-dev
+```
+
+The development versions of OpenGL, GLFW3, GLEW are required to build the client.
+
+```bash
+sudo apt install libgl1-mesa-dev libglfw3-dev libglew-dev
+```
+
+For building the server the SQLite3 development library is required.
+
+```bash
+sudo apt install libsqlite3-dev
+```
+
+Don't forget to pull the submodules before building.
+
+``bash
+git submodule update --init
+```
 
 ## Available targets
 - `all` (default)
@@ -9,10 +34,11 @@ 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
 
-## Release Build
 ```bash
-./release.sh
+./snapshot.sh
 ```
-This script will create a release zipfile.
+This script will create a snapshot zipfile.