aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorralmn <[email protected]>2013-06-16 21:45:21 +0200
committerralmn <[email protected]>2013-06-16 21:45:21 +0200
commit7a3fe20368bfda16025dd5ca897f7614532edbcc (patch)
treedf43530c875a73c3ffe0f2df803df691196d0c99 /README.md
parent0c7072f7909fd36eaac9b83c772d5e052198058f (diff)
downloadPaper-7a3fe20368bfda16025dd5ca897f7614532edbcc.tar.gz
Paper-7a3fe20368bfda16025dd5ca897f7614532edbcc.zip
ReadMe Edit
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2e5358111e..43e1115a65 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,37 @@ Spigot [![Build Status](https://travis-ci.org/EcoCityCraft/Spigot.png)](https://
===========
High performance Minecraft server implementation
+
+
+How To
+-----------
+
+Init a Craftbukkit and Bukkit module : `git submodule update --init`
+
+Apply Patches : `./applyPatches.sh`
+
+### Create patch for server ###
+
+`cd Spigot-Server`
+Add your file for commit : `git add <file>`
+Commit : `git commit -m <msg>`
+`cd ..`
+Create Patch `./rebuildPatches.sh`
+
+### Create patch for API ###
+
+`cd Spigot-API`
+Add your file for commit : `git add <file>`
+Commit : `git commit -m <msg>`
+`cd ..`
+Create Patch `./rebuildPatches.sh`
+
+
+
+Compilation
+-----------
+
+We use maven to handle our dependencies.
+
+* Install [Maven 3](http://maven.apache.org/download.html)
+* Check out this repo and: `mvn clean install`