Fix memory bug at shutdown

[dragonblocks_alpha.git] / BUILDING.md

diff --git a/BUILDING.md b/BUILDING.md
index 10539b7b9b6d9bcc735999e7d7c5ebff467cc00b..79243ec7168e4fbe9b782b0fd074481855997a89 100644 (file)
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,34 +1,48 @@
 # 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
-```
+You need Git, CMake, Lua, Bash and GCC. Make sure these dependencies are installed on your system. (on Debian based systems: `apt install git cmake build-essential lua5.4`)
+
+All other dependencies are included as submodules, compiled automatically and statically linked.
+Make sure to clone the repository recursively:
 
-The development versions OpenGL, GLFW3, GLEW are required to build the client.
 ```bash
-sudo apt install libgl1-mesa-dev libglfw3-dev libglew-dev
+git clone --recurse-submodules https://github.com/dragonblocks/dragonblocks_alpha.git
 ```
 
-When building the client, don't forget to pull the submodules before building.
-``bash
-git submodule update --init
+## Client dependencies
+
+If you want to build the client, it is required to install the build dependencies for GLEW and GLFW (on X11/Debian based systems: `apt install xorg-dev libgl1-mesa-dev`).
+
+Refer to:
+- https://www.glfw.org/docs/3.3/compile.html
+- http://glew.sourceforge.net/build.html
+
+## Building a debug build
+By default CMake will make a debug build if nothing else is specified. Simply use
+
+```bash
+cmake -B build -S src
+cd build
+make -j$(nproc)
 ```
 
-## Available targets
-- `all` (default)
-- `Dragonblocks`
-- `DragonblocksServer`
-- `clean`
-- `clobber`
+to build the dragonblocks client and server.
+If you use a debug build, the singleplayer script should be invoked from the build/ directory, because that's where the binaries are located.
 
-The debug flag (`-g`) is set by default (RELEASE=TRUE will disable it).
+## Building a release snapshot
 
-## Release
 ```bash
-./release.sh
+# Native snapshot
+./snapshot.sh
+
+# Crosscompiling for windows
+
+# win32 (requires i686-w64-mingw32-gcc-posix)
+./snapshot.sh win32
+
+# win64 (requires x86_64-w64-mingw32-gcc-posix)
+./snapshot.sh win64
 ```
-This script will create a release zipfile.
+
+Creates snapshot zipfiles.