diff options
Diffstat (limited to '')
| -rw-r--r-- | COMPILING | 8 | ||||
| -rw-r--r-- | COMPILING.md | 27 |
2 files changed, 27 insertions, 8 deletions
diff --git a/COMPILING b/COMPILING deleted file mode 100644 index 708e4413e..000000000 --- a/COMPILING +++ /dev/null @@ -1,8 +0,0 @@ -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. 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. |