summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorErik Broes <erikbroes@grum.nl>2011-01-03 19:32:42 +0100
committerErik Broes <erikbroes@grum.nl>2011-01-09 18:28:46 +0100
commitb72dad0a61d11c01c498a7e58b3e4a7389533488 (patch)
tree3bba2fffd88dd99b3b7232da0b7faf1d93512c46 /README.md
parentdb31429871826037eaf824f81b68271321f4fa8a (diff)
downloadcraftbukkit-b72dad0a61d11c01c498a7e58b3e4a7389533488.tar
craftbukkit-b72dad0a61d11c01c498a7e58b3e4a7389533488.tar.gz
craftbukkit-b72dad0a61d11c01c498a7e58b3e4a7389533488.tar.lz
craftbukkit-b72dad0a61d11c01c498a7e58b3e4a7389533488.tar.xz
craftbukkit-b72dad0a61d11c01c498a7e58b3e4a7389533488.zip
Added compile instructions in README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d5719e2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+CraftBukkit
+===========
+
+A Bukkit (Minecraft Server API) implementation
+
+Compilation
+-----------
+
+We use maven to handle our dependencies.
+
+* Install [Maven 3](http://maven.apache.org/download.html)
+* Check out and install [Bukkit](http://github.com/Bukkit/Bukkit)
+* Check out this repo and: `mvn clean package`