diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0665186 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2023 Freya Murphy + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. 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 ` + +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