mention that --help is available
[nihav-tool.git] / README.md
... / ...
CommitLineData
1# nihav-tool
2
3nihav-tool is a simple tool to test decoding functionality of NihAV.
4
5## Getting Started
6
7Put it into directory with other NihAV crates and invoke `cargo build`.
8
9See https://codecs.multimedia.cx/2020/07/some-words-about-nihav-tools/ for a description of how to use it.
10Or run `nihav-tool --help`.
11
12## Contributing
13
14You're not supposed to. Even I hardly do that so why should you?
15
16## License
17
18NihAV is licensed under GNU Affero Public License - see [COPYING] for details.
19
20Parts of the project can be relicensed to other free licenses like LGPLv2 on request.