summaryrefslogtreecommitdiffstats
path: root/COMPILING.md
diff options
context:
space:
mode:
Diffstat (limited to 'COMPILING.md')
-rw-r--r--COMPILING.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/COMPILING.md b/COMPILING.md
new file mode 100644
index 000000000..e10acee98
--- /dev/null
+++ b/COMPILING.md
@@ -0,0 +1,27 @@
+COMPILING
+=========
+
+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 . -DCMAKE_BUILD_TYPE=RELEASE && 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
+
+32 Bit Mode
+-----------
+
+This is useful if you want to compile MCServer to use on another 32-bit machine. It can be used with debug or release mode. To use 32 bit mode, simply add:
+
+ -DFORCE_32=1
+
+to your cmake command and 32 bit will be forced.