[nihav-player.git] / old / README.md

# nihav-player

nihav-player is an extremely simple tool to test decoding functionality of NihAV.

## Getting Started

This is a not a stable working application and it is provided just as a demonstration and not as something you should ever use.

In order to build it, put it into directory with other NihAV crates, check out `sdl-0.3.6` crate from https://crates.io/crates/sdl into `rust-sdl` subdirectory, apply patches from `sdl-patches` to it, and invoke `cargo build`.

Usage: `nihav-player [-an] inputfile`. `-an` tells player to ignore audio stream.

## Contributing

You're not supposed to. Even I hardly do that so why should you?

## License

NihAV is licensed under GNU Affero Public License - see [COPYING] for details.

Parts of the project can be relicensed to other free licenses like LGPLv2 on request.
Commit	Line	Data
4b73bc27 KS	1	# nihav-player
	2
	3	nihav-player is an extremely simple tool to test decoding functionality of NihAV.
	4
	5	## Getting Started
	6
0036a7b0 KS	7	This is a not a stable working application and it is provided just as a demonstration and not as something you should ever use.
	8
	9	In order to build it, put it into directory with other NihAV crates, check out `sdl-0.3.6` crate from https://crates.io/crates/sdl into `rust-sdl` subdirectory, apply patches from `sdl-patches` to it, and invoke `cargo build`.
4b73bc27 KS	10
	11	Usage: `nihav-player [-an] inputfile`. `-an` tells player to ignore audio stream.
	12
	13	## Contributing
	14
	15	You're not supposed to. Even I hardly do that so why should you?
	16
	17	## License
	18
	19	NihAV is licensed under GNU Affero Public License - see [COPYING] for details.
	20
	21	Parts of the project can be relicensed to other free licenses like LGPLv2 on request.