summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorbearbin <bearbin@gmail.com>2013-07-27 15:25:23 +0200
committerbearbin <bearbin@gmail.com>2013-07-27 15:25:23 +0200
commit204ae378b0869cb7527bca400db48015da613a17 (patch)
tree27803a8f539e298da61c12927c4f5d2c60dc314b /README.md
parentHunger: If a player dies the food level resets. (diff)
parentAdd README, fixes #1 (diff)
downloadcuberite-204ae378b0869cb7527bca400db48015da613a17.tar
cuberite-204ae378b0869cb7527bca400db48015da613a17.tar.gz
cuberite-204ae378b0869cb7527bca400db48015da613a17.tar.bz2
cuberite-204ae378b0869cb7527bca400db48015da613a17.tar.lz
cuberite-204ae378b0869cb7527bca400db48015da613a17.tar.xz
cuberite-204ae378b0869cb7527bca400db48015da613a17.tar.zst
cuberite-204ae378b0869cb7527bca400db48015da613a17.zip
Diffstat (limited to '')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..7b57c3234
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+MCServer
+========
+
+MCServer is a performant C++ Minecraft server designed for use in memory and cpu-limited places, or just to make regular server perform better.
+
+MCServer can run on PCs, Macs, and *nix. This includes android phones and tablets as well as Raspberry Pis.
+
+Installation
+------------
+
+To install MCServer, you can either download the repository and compile it, or download a pre-compiled version.
+
+Compilation instructions are available in the COMPILING file.
+
+Linux builds can be downloaded from [the Berboe CI server](http://ci.berboe.co.uk) and windows from xoft's [nightly build service](mc-server.xoft.cz).
+
+After you've extracted the files, simply run the MCServer executable.
+
+Contributing
+------------
+
+MCServer is licensed under the Apache license V2, and we welcome anybody to fork and submit a Pull Request back with their changes, and if you want to join as a permanent member we can add you to the team.
+
+Other Stuff
+-----------
+
+For other stuff, including plugins and discussion, check the [forums](http://forum.mc-server.org) and [wiki](https://github.com/mc-server/MCServer/wiki).