Fix timing bugs and add documentation

[m17rt] / m17codec2 / README.md

diff --git a/m17codec2/README.md b/m17codec2/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0475c2823e17c01b109b783d85a461e91e636cec 100644 (file)
--- a/m17codec2/README.md
+++ b/m17codec2/README.md
@@ -0,0 +1,8 @@
+# m17codec2
+
+Part of the [M17 Rust Toolkit](https://octet-stream.net/p/m17rt/). Pre-made adapters designed for the `m17app` crate that make it easier to work with Codec2 voice streams.
+
+* `WavePlayer` - transmit a wave file as a stream (8 kHz, mono, 16 bit LE)
+* `Codec2Adapter` - receive all incoming streams and attempt to play the decoded audio on the default sound card
+
+**Important licence note:** While `m17codec2` is under the MIT licence, it uses the `codec2` crate as a dependency, which will statically link LGPL code in the build. If you are distributing software in a way where LGPL compliance requires special care (e.g., dynamic linking), consider implementing your own codec2 adapters in a way that is compliant in your scenario.