summaryrefslogtreecommitdiffstats
path: root/old/README.md
diff options
context:
space:
mode:
authorKostya Shishkov <kostya.shishkov@gmail.com>2020-10-07 16:02:57 +0200
committerKostya Shishkov <kostya.shishkov@gmail.com>2020-10-07 16:02:57 +0200
commit113ac3d202140491de9a8ad1e75dd96882a8857f (patch)
tree34425f2594d8ddfd9be88a044c32d6175c7f4fad /old/README.md
parent0036a7b08b18389e0d8683fe1422ffb861dd9327 (diff)
downloadnihav-player-113ac3d202140491de9a8ad1e75dd96882a8857f.tar.gz
move experimental code to old/
Diffstat (limited to 'old/README.md')
-rw-r--r--old/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/old/README.md b/old/README.md
new file mode 100644
index 0000000..0f00772
--- /dev/null
+++ b/old/README.md
@@ -0,0 +1,21 @@
+# 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.