Skip to content

Commit

Permalink
[ci skip] Update README.md (#1642)
Browse files Browse the repository at this point in the history
Co-authored-by: granny <[email protected]>
  • Loading branch information
z5tm and granny authored Feb 6, 2025
1 parent fdc28ee commit d8aadde
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,28 +94,23 @@ First, <u>clone</u> this repository. Do not download it.
Then run the following command in the root directory:

```
./gradlew applyPatches
./gradlew applyAllPatches
```

The project is now ready for use in your IDE.

#### Creating a patch
Patches are effectively just commits in either `Purpur-API` or `Purpur-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.

See [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information.

See [CONTRIBUTING.md](CONTRIBUTING.md).

#### Compiling

Use the command `./gradlew build` to build the API and server. Compiled JARs
will be placed under `Purpur-API/build/libs` and `Purpur-Server/build/libs`.
will be placed under `purpur-api/build/libs` and `purpur-server/build/libs`.
**These JARs are not used to start a server.**

To compile a server-ready purpurclip jar, run `./gradlew createMojmapBundlerJar`.
To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`. The compiled purpurclip jar will be in `build/libs/` not `Purpur-Server/build/libs`.
To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`. The compiled purpurclip jar will be in `purpur-server/build/libs`.

Special Thanks To:
-------------
Expand Down

0 comments on commit d8aadde

Please sign in to comment.