readme update

jontio · Apr 7, 2021 · 49d0afa · 49d0afa
1 parent 92d507a
commit 49d0afa
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,20 @@
-# JC2Rec is a GUI in Qt for recording speech using Codec2.
+# JC2Rec is a GUI in Qt for recording speech using Codec2
 
-This is a simple speech recording application that uses Codec2 and Qt. For more information see https://jontio.zapto.org/hda1/jc2rec.html
+[Codec2] is an audio compression codec designed for speech. The codec is designed for very high compression ratios. It has bit rates as low as 450 bits per second!!!
+
+I wrote this application to make audio recordings with this audio compressor.
+
+![](images/app.png)
+
+For more information see https://jontio.zapto.org/hda1/jc2rec.html
+
+### Building
+
+You will need the [codec2 repo] cloned into a directory above the jc2rec repo. You'll have to build codec2 and have all the required QT things. On Windows I suggest using [MSYS2] to install everything needed.
+
+Jonti<br>
+2021
+
+[Codec2]: http://www.rowetel.com/wordpress/?page_id=452
+[codec2 repo]: https://github.com/drowe67/codec2
+[MSYS2]: https://www.msys2.org/
diff --git a/images/app.png b/images/app.png