Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WindSoilder committed Aug 7, 2022
1 parent e504119 commit 947c11f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Nu plugin binary reader
A general binary parser based on [kaitai struct](https://formats.kaitai.io/).
A [nushell](https://www.nushell.sh/) plugin to read binary dataA general binary parser based on [kaitai struct](https://kaitai.io/).

## Require python version
python3.7+
Expand All @@ -26,3 +26,7 @@ open FiraCode-VF.ttf | from-binary ttf | get directory_table
## Note
The `kaitaistruct.py` is just a copy of [kaitai struct python runtime](https://github.com/kaitai-io/kaitai_struct_python_runtime), put it directly here, so we don't need extra requirements.
And `reader/*.py` are just a copy of auto-generated parser, DON'T CHANGE IT.

## For more references
- [Nushell plugin system](https://www.nushell.sh/book/plugins.html)
- [kaitai struct](https://kaitai.io/)

0 comments on commit 947c11f

Please sign in to comment.