README

* WARNING : This is NOT a stable release, so if you encounter problems,
  please report all of them and don't hesitate to send patches. 
  Bugtracker: https://github.com/SuckerServ/miaoumod/issues *

== How to build MiaouMod ==

Installation guide : https://wiki.piernov.org/en:miaoumod:installation

Be sure to install all the dependencies needed!
List: https://wiki.piernov.org/en:miaoumod:installation#required_dependencies

= Quick installation =

Make sure the script is marked as executable:
    chmod +x compile.sh
Then run it:
    ./compile.sh

Usage: ./compile.sh [--recompile] [--debug] — Build SuckerServ-v5
          --recompile   — Delete $COMPILEDIR (release_build or debug_build with --debug) before compiling SuckerServ again
          --debug       — Make a debug build

In case the compilation fails with memory allocation error, you can try to 
lower the number of threads used to compile by setting the THREADS variable.
For exemple:
    THREADS=1 ./compile.sh


== Starting and stopping the server ==

To start the server, run:
    ./bin/server start
And to stop it:
    ./bin/server stop


== Configuration ==

The configuration file is located at conf/server-init.cfg


== Help ==

For more informations, read the wiki located at: https://wiki.piernov.org/
You can also contact us at IRC: #suckerserv@irc.gamesurge.net