diff --git a/README.md b/README.md index 9484487..d766905 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Parchment -This is a fork of [Paper](https://github.com/PaperMC/Paper) for the [Project Eden](https://bnn.gg/) server. +This is a fork of [Paper](https://github.com/PaperMC/Paper) for the [Project Eden](https://projecteden.gg/) Minecraft server. It contains changes to the API to make development of our plugin [Nexus](https://github.com/Pugabyte/Nexus) easier. ## Building @@ -14,18 +14,18 @@ Requirements: If all you want is a paperclip server jar, just run `./parchment jar`. -Otherwise, to setup the `Parchment-API` and `Parchment-Server` repo, just run the following command -in your project root `./parchment patch` additionally, after you run `./parchment patch` you can run `./parchment build` to build the -respective api and server jars. +Otherwise, to setup the `Parchment-API` and `Parchment-Server` repo, just run `./parchment patch` +in your project root. Afterwards you can run `./parchment build` to build the +respective API and server jars. `./parchment patch` should initialize the repo such that you can now start modifying and creating -patches. The folder `Parchment-API` is the api repo and the `Parchment-Server` folder -is the server repo and will contain the source files you will modify. +patches. The folder `Parchment-API` is the API repository and the `Parchment-Server` folder +is the server repository. These contain the source files you will modify. ### Creating a patch Patches are effectively just commits in either `Parchment-API` or `Parchment-Server`. -To create one, just add a commit to either repo and run `./parchment rb`, and a +To create one, just add a commit to either repo and run `./parchment rb` and a patch will be placed in the patches folder. Modifying commits will also modify its corresponding patch file.