From 40cbc7a416e8debd874ffd38540a44d574d8cb6d Mon Sep 17 00:00:00 2001 From: Andrew Lalis Date: Sun, 28 May 2023 21:48:48 +0200 Subject: [PATCH] Improved readme. --- .gitignore | 3 ++- README.md | 16 ++++++++++++++++ build.sh | 7 +++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100755 build.sh diff --git a/.gitignore b/.gitignore index e673575..8b956fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .idea/ -target/ \ No newline at end of file +target/ +materials-extractor.jar diff --git a/README.md b/README.md index b0348c2..7de1fcf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # MaterialsExtractor Program to extract a list of materials from an NBT structure file. + +## Usage +```shell +git clone git@github.com:andrewlalis/MaterialsExtractor.git +cd MaterialsExtractor +./build.sh +``` + +Usage information: +``` +java -jar materials-extractor.jar [paste.ee token] + Where + First argument (required) is the path to the .nbt schematic file to read. + Second argument (optional) is an api token to https://paste.ee, to + automatically upload item-list for usage. +``` diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..93e1a2f --- /dev/null +++ b/build.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env bash + +./mvnw clean package +cp target/materials-extractor-*-jar-with-dependencies.jar ./materials-extractor.jar + +echo "Built project as materials-extractor.jar" +echo "Run: java -jar materials-extractor.jar [paste.ee token]"