From c42623daa141833c2a93a832b0eba9507bddbc6a Mon Sep 17 00:00:00 2001 From: Lexi Date: Tue, 6 Dec 2022 18:26:23 -0500 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dcc6d8d..fc7b281 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,21 @@ It contains changes to the API to make development of our plugin [Nexus](https:/ Requirements: - You need `git` installed, with a configured username and email. On Windows you need to run from git bash. -- You need `jdk` 16+ installed to compile (and `jre` 16+ to run). +- You need `jdk` 17+ installed to compile (and `jre` 17+ to run). -If all you want is a paperclip server jar, just run `./gradlew paperclipJar`. +If all you want is a paperclip server jar, just run `./gradlew createReobfPaperclipJar`. -Otherwise, to setup the `Parchment-API` and `Parchment-Server` repo, just run +Otherwise, to setup the `parchment-api` and `parchment-server` repos, just run `./gradlew applyPatches` in your project root. Afterwards you can run `./gradlew build` to build the respective API and server jars. `./gradlew applyPatches` should initialize the repo such that you can now start modifying and -creating patches. The folder `Parchment-API` is the API repository and the `Parchment-Server` +creating 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`. +Patches are effectively just commits in either `parchment-api` or `parchment-server`. To create one, just add a commit to either repo and run `./gradlew rebuildPatches` and a patch will be placed in the patches folder. Modifying commits will also modify its corresponding patch file. @@ -30,4 +30,4 @@ corresponding patch file. ## License The fork is based off of [paperweight-examples](https://github.com/PaperMC/paperweight-examples). -See its project page for the license of material used/modified by this project. \ No newline at end of file +See its project page for the license of material used/modified by this project.