]> git.lizzy.rs Git - dragonblocks_alpha.git/blobdiff - BUILDING.md
Fix memory bug at shutdown
[dragonblocks_alpha.git] / BUILDING.md
index 723d2b71aadc8b352a558a34611ec5c6d8f5e7de..79243ec7168e4fbe9b782b0fd074481855997a89 100644 (file)
@@ -1,7 +1,8 @@
 # Building instructions
 
 ## Dependencies
-To build anything you need Git, CMake, Lua, Bash and GCC. Make sure these dependencies are installed on your system.
+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:
 
@@ -9,6 +10,14 @@ Make sure to clone the repository recursively:
 git clone --recurse-submodules https://github.com/dragonblocks/dragonblocks_alpha.git
 ```
 
+## 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
 
@@ -27,8 +36,13 @@ If you use a debug build, the singleplayer script should be invoked from the bui
 # Native snapshot
 ./snapshot.sh
 
-# Crosscompiling for windows (requires i686-w64-mingw32-gcc-posix)
-./snapshot.sh mingw
+# Crosscompiling for windows
+
+# win32 (requires i686-w64-mingw32-gcc-posix)
+./snapshot.sh win32
+
+# win64 (requires x86_64-w64-mingw32-gcc-posix)
+./snapshot.sh win64
 ```
 
 Creates snapshot zipfiles.