diff options
| author | Freya Murphy <freya@freyacat.org> | 2023-12-14 19:50:39 -0500 |
|---|---|---|
| committer | Freya Murphy <freya@freyacat.org> | 2023-12-14 19:50:39 -0500 |
| commit | eaa1d434a04de3ff7798c4c61eeb4c82946d99af (patch) | |
| tree | 58093560f0d007bba65750bab1ce4c2c8265dd09 /README.md | |
| parent | initial stable (diff) | |
| download | nbtvis-eaa1d434a04de3ff7798c4c61eeb4c82946d99af.tar.gz nbtvis-eaa1d434a04de3ff7798c4c61eeb4c82946d99af.tar.bz2 nbtvis-eaa1d434a04de3ff7798c4c61eeb4c82946d99af.zip | |
docs
Diffstat (limited to '')
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1220ca9 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +### nbtvis + +Command line visualizer for the minecraft [NBT](https://wiki.vg/NBT) data file format. + +#### usage + +`nbtvis <file.nbt>` + +You can know if a file is NBT if the first byte in hexdump is `0a` + +#### complementation + +To build and install run + +``` +make build +sudo make install +``` + +The binary will be installed to `/usr/lcoal/bin/nbtvis` + +#### license + +This project is licensed under the [MIT](https://mit-license.org/) license |