add nihav-sndplay

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

diff --git a/sndplay/README.md b/sndplay/README.md
new file mode 100644 (file)
index 0000000..e082775
--- /dev/null
+++ b/sndplay/README.md
@@ -0,0 +1,30 @@
+# nihav-sndplay
+
+nihav-sndplay is a minimalistic audio player based on NihAV and SDL2.
+
+## Getting Started
+
+In order to build it, put it into some subdirectory with other NihAV crates (or edit `Cargo.toml` to point to the proper crate locations) and invoke `cargo build`.
+
+Usage: `nihav-sndplay file1 file2 ...`.
+
+Recognized keyboard commands:
+* `escape` / `q`    - quit
+* `space`           - pause / resume playback
+* `enter` / `end`   - play next file
+* `home`            - play current track from the beginning
+* `left` / `right`  - seek 10 seconds forward / back
+* `up` / `down`     - seek 1 minute forward / back
+* `pgup` / `pgdn`   - seek 10 minutes forward / back
+* `+` / `-`         - increase / decrease volume
+* `m`               - mute output
+
+## 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.