Improved readme.

This commit is contained in:
Andrew Lalis 2023-05-28 21:48:48 +02:00
parent a99aa47403
commit 40cbc7a416
3 changed files with 25 additions and 1 deletions

3
.gitignore vendored
View File

@ -1,2 +1,3 @@
.idea/
target/
target/
materials-extractor.jar

View File

@ -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 <schematic-file.nbt> [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.
```

7
build.sh Executable file
View File

@ -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 <schematic-file.nbt> [paste.ee token]"