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 ` +Commit : `git commit -m ` +`cd ..` +Create Patch `./rebuildPatches.sh` + +### Create patch for API ### + +`cd Spigot-API` +Add your file for commit : `git add ` +Commit : `git commit -m ` +`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`