summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKostya Shishkov <kostya.shishkov@gmail.com>2020-07-24 17:42:23 +0200
committerKostya Shishkov <kostya.shishkov@gmail.com>2020-07-24 17:42:23 +0200
commit0036a7b08b18389e0d8683fe1422ffb861dd9327 (patch)
treea330dd58e3fe53afe059bf4c56a2d941ad391576
parent4b73bc27a2026052746615e6a25d30f9a9bdb0bc (diff)
downloadnihav-player-0036a7b08b18389e0d8683fe1422ffb861dd9327.tar.gz
update documentation
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index b660b16..0f00772 100644
--- 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.