add COPYING and README.md
[nihav-player.git] / README.md
CommitLineData
4b73bc27
KS
1# nihav-player
2
3nihav-player is an extremely 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
9Usage: `nihav-player [-an] inputfile`. `-an` tells player to ignore audio stream.
10
11## Contributing
12
13You're not supposed to. Even I hardly do that so why should you?
14
15## License
16
17NihAV is licensed under GNU Affero Public License - see [COPYING] for details.
18
19Parts of the project can be relicensed to other free licenses like LGPLv2 on request.