diff --git a/Compiling.md b/Compiling.md new file mode 100644 index 0000000..663d4b2 --- /dev/null +++ b/Compiling.md @@ -0,0 +1,39 @@ +Make sure you have [CMake](http://cmake.org/), and of course, a C compiler, +on your system before proceeding. + +For Windows, try [MinGW32](http://mingw.org/). For Unix-based systems, you +should not have any problems with the C compiler since there's one (almost) +always available. [Puppy Linux](http://puppylinux.org) users of course need +a separate `devx.sfs` (from the same place where you got the Puppy ISO), +since vanilla Puppy does not come with `gcc`. See your Puppy docs for more +info about how to install additional SFS files. + +If you are impatient: + +```bash +git clone https://github.com/kaeza/minetest-irc.git \ + && cd minetest-irc \ + && git submodule update --init \ + && ./quick_install.sh /path/to/mods +``` + +Please change `/path/to/mods` to fit your install of Minetest. + +To compile and pack the mod: + +* Open a command prompt/terminal and CD to the `minetest-irc` directory. +* (optional) Create a directory named `Build`, and CD into it. +* Run CMake to generate the build system (see your CMake docs for more + information about command line options, in particular the `-G` option). +* Use the build tool for the generated build system to compile the + native library. For example, if using Microsoft Visual Studio, open + the generated workspace and build from there. If using make, just run + `make` from within the Build directory. +* After building you will have a folder named `irc` in your build folder. + Move that to your mod folder. + +### Installing ### + +Just put the created `irc` directory in any of the directories where +Minetest looks for mods. For more information, see +[here](http://wiki.minetest.com/wiki/Installing_mods).