From 0c5d872764a04b955cc62e56fb1a8feb3575449d Mon Sep 17 00:00:00 2001 From: Flowsqy <47575244+Flowsqy@users.noreply.github.com> Date: Sun, 24 Jul 2022 04:32:06 +0200 Subject: [PATCH] Update build instructions in README --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0019eab..bcbc1a8 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,11 @@ Maybe in future I will post an official API through github packages, but current ## Build -You need Maven and a jdk. +You need Maven with Github access and a jdk. +If you don't know how to give Github access to maven, check [this](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token). +If you don't know how to create a personal token, check [this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). -- First, compile spigot with the BuildTools.jar and the '--remapped' argument. - You need to do it for a lot of minecraft version, starting from 1.17. - To get them all, just do the next step, an error message will tell you what minecraft version is missing. - (I will try to suppress this step in future) -- Use ``mvn clean package`` or ``mvn clean install`` at the root of the project to build ShopChest artefact. +- Use ``mvn clean install`` at the root of the project to build ShopChest artefact. - After the build succeeded, the ShopChest.jar is found in the ``/plugin/target/`` folder. ## Issues