add COPYING and README.md

[nihav-encoder.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..ae8267e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# nihav-encoder
+
+nihav-encoder is a simple tool to test encoding functionality of NihAV.
+
+## Getting Started
+
+Put it into directory with other NihAV crates and invoke `cargo build`.
+
+See https://codecs.multimedia.cx/2020/07/some-words-about-nihav-tools/ for a description of how to use it.
+
+## 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.