Improved readme.
This commit is contained in:
parent
a99aa47403
commit
40cbc7a416
|
@ -1,2 +1,3 @@
|
|||
.idea/
|
||||
target/
|
||||
target/
|
||||
materials-extractor.jar
|
||||
|
|
16
README.md
16
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 <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.
|
||||
```
|
||||
|
|
|
@ -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]"
|
Loading…
Reference in New Issue