Skip to content

Commit

Permalink
short docs in readme about local development
Browse files Browse the repository at this point in the history
  • Loading branch information
rfresh2 committed Dec 29, 2024
1 parent cfe72e1 commit 5fd916d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,17 @@ See the [Linux Guide](https://github.com/rfresh2/ZenithProxy/wiki/Linux-Guide) f

Current limits are documented in [a discord channel](https://discord.com/channels/1127460556710883391/1200685719073599488)

### Development

I highly recommend using Intellij for building and running local development instances.

Gradle will automatically install the required Java version for compiling (currently Java 23)

Most useful gradle tasks:
* `run` - Builds and runs a local dev instance
* `jarBuild` - Builds an executable jar to `build/libs/ZenithProxy.jar`
* `build` - Compiles and runs tests without building a jar

## Special Thanks

* [Pork2b2tBot Contributors](https://github.com/PorkStudios/Pork2b2tBot/graphs/contributors)
Expand Down

0 comments on commit 5fd916d

Please sign in to comment.