core
/
testserver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README for PR instructions

This commit is contained in:
Aikar 2016-03-28 23:59:04 -04:00
parent ebe7176b2e
commit 08c9934f83
1 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -6,26 +6,48 @@ High performance Spigot fork that aims to fix gameplay and mechanics inconsisten
[IRC Support and Project Discussion](http://irc.spi.gt/iris/?channels=PaperSpigot)
Documentation
------
Access the paper docs here: [paper.readthedocs.org](https://paper.readthedocs.org/)
How To (Server Admins)
------
Paperclip is a jar file that you can download and run just like a normal jar file.
Download a copy of Paperclip.jar from our buildserver here:
https://ci.destroystokyo.com/job/PaperSpigot/
Run the Paperclip jar directly from your server. Just like old times
Paperclip requires **Java 8** or above.
Paper requires [**Java 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) or above.
How To (Compiling From Source)
How To (Compiling Jar From Source)
------
To compile Paper, you need JDK 8, maven, and an internet connection.
Clone this repo, run ./build.sh --jar from *bash*, get files.
Clone this repo, run `./build.sh --jar` from *bash*, get files.
Leave off --jar if you only wish to resync your checkout and not create a paperclip jar file just yet.
How To (Pull Request)
------
Clone this repo, run `./build.sh` from *bash*, get files.
Load Paper-API and Paper-Server into your IDE, make changes.
Commit your changes in each retrospective folder.
If you are editing a previous patch, commit, and then use `git rebase -i upstream/upstream`
and then move your commit line to the commit you are editing and use code "f" or "s"
Once your commit is in place, cd back into Paper folder, and type `./rebuildPatches.sh`
You should now see either a new patch or an edited patch in your `git status`
Now, write a commit message for the patch files. For new patches, you can just repeat the commit message used in the patch commit itself, but if editing, explain what the change to the patch is.
now `git checkout -b someBranchName`, then `git remote add myorigin git@github.com:myname/Paper` and `git push myorigin someBranchName` and then proceed to PR.
Special Thanks To:
-------------