summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..68acc4411
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+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.
+