]> git.nihav.org Git - nihav-player.git/commitdiff
update documentation
authorKostya Shishkov <kostya.shishkov@gmail.com>
Fri, 24 Jul 2020 15:42:23 +0000 (17:42 +0200)
committerKostya Shishkov <kostya.shishkov@gmail.com>
Fri, 24 Jul 2020 15:42:23 +0000 (17:42 +0200)
README.md

index b660b16d3943df1075df0f8aa361d3b3d5023678..0f007724d22503a88ec923e6c0ee006755520de3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,9 @@ nihav-player is an extremely simple tool to test decoding functionality of NihAV
 
 ## Getting Started
 
-Put it into directory with other NihAV crates and invoke `cargo build`.
+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.