Frustum culling

[dragonblocks_alpha.git] / BUILDING.md

diff --git a/BUILDING.md b/BUILDING.md
index ad558df108fd3f139ad038b3d2129da142adadff..2f8aaa7a0ac628275fd929faba2c1e8b0201734b 100644 (file)
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,18 +1,45 @@
 # Building instructions
 
-The code and the Makefile are located in the src/ directory
+CMake is used for compiling. Make sure to clone the repository recursively:
 
-## Available targets
-- `all` (default)
-- `Dragonblocks`
-- `DragonblocksServer`
-- `clean`
-- `clobber`
+``bash
+git clone --recurse-submodules https://github.com/dragonblocks/dragonblocks_alpha.git
+```
+
+## Dependencies
+To build anything you need CMake. The ZLib development library is needed as well.
+
+```bash
+sudo apt install build-essential cmake zlib1g-dev
+```
+
+The development versions of OpenGL, GLFW3, GLEW and Freetype are required to build the client.
+
+```bash
+sudo apt install libgl1-mesa-dev libglfw3-dev libglew-dev libfreetype-dev
+```
+
+For building the server the SQLite3 development library is required.
+
+```bash
+sudo apt install libsqlite3-dev
+```
+
+## Building a debug build
+By default CMake will make a Debug build if nothing else is specified. Simply use
+
+```bash
+cd src
+cmake .
+make -j$(nproc)
+```
+
+to build the dragonblocks client and server.
+If you use a debug build, the singleplayer script should be invoked from the src/ directory, because that's where the binaries are located.
 
-Debug flag (`-g`) is set by default.
+## Building a snapshot
 
-## Release Build
 ```bash
-./release.sh
+./snapshot.sh
 ```
-This script will create a release zipfile.
+This script will create a snapshot zipfile.