summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--COMPILING20
1 files changed, 15 insertions, 5 deletions
diff --git a/COMPILING b/COMPILING
index 708e4413e..5a9f9b6c2 100644
--- a/COMPILING
+++ b/COMPILING
@@ -1,8 +1,18 @@
COMPILING
=========
-To compile MCServer on *nix, you need a GNUmake-compatible make that reads GNUmakefile.
-Run "make" to build a debug version (slow, but gives more info on crash)
-Run "make release=1" to build a release version (fast, less info on crash)
-Add addm32=1 to compile in 32-bit mode on 64-bit systems.
-Add `-j 4` to use 4 threads and speed up compilation on multi-core devices.
+To compile MCServer on *nix, you need CMake and make, as well as a C compiler, C++ compiler and linker.
+
+Release Mode
+------------
+
+Release mode is preferred for almost all cases, it has much better speed and less console spam. However, if you are developing MCServer actively, debug mode might be better.
+
+ cmake . && make
+
+Debug Mode
+----------
+
+Debug mode is useful if you want more debugging information about MCServer as it's running or if you want to use a debugger like GDB to debug issues and crashes.
+
+ cmake . -DCMAKE_BUILD_TYPE=DEBUG && make