From f21b0d8214f7431067f48e83d978219275daad85 Mon Sep 17 00:00:00 2001 From: unurled Date: Wed, 28 Feb 2024 18:53:24 +0100 Subject: [PATCH] building and running in readme.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 064fb5e..750b7a4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Sacred Realms -see [docs](https://git.unurled.me/SacredRealms/docs) for more information \ No newline at end of file +see [docs](https://git.unurled.me/SacredRealms/docs) for more information + +## Build Instructions + +### Prerequisites + +- [Java 17](https://adoptium.net/temurin/releases/?version=17) +- `git clone https://git.unurled.me/SacredRealms/SR-Game.git` + +### Building + +```bash +./gradlew build +``` + +## Running + +- [Java 17](https://adoptium.net/temurin/releases/?version=17) +- [PaperMC 1.20.4](https://papermc.io/downloads/paper) or any fork of it (purpur, etc) +- a build of the plugin \ No newline at end of file