--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun Jul 21 22:40:24 2024 +0000
@@ -0,0 +1,18 @@
+This Hg repository contains a mostly-raw import of GSM-HR speech codec
+implementation from the original GSM 06.06 publication.  The only modification
+that has been made is a minimally-invasive surgical change to gsm_hr.c (the
+main module) that allows the default noisy output to be suppressed at run time,
+rather than at compile time, and suppresses all of this noisy output rather
+than just one part of it.  Also a Makefile has been added, for straightforward
+compilation on "semi-modern" systems such as Slackware Linux.
+
+This work has been produced for two purposes:
+
+1) To make it possible to actually run this original GSM-HR code, before the
+   laborious effort of librifying it and incorporating it into gsm-codec-lib,
+   and for verification. testing and comparison after that planned work.
+
+2) To have the code readily available in a public Hg repository, allowing
+   direct links to individual files or even to line numbers.  Such easy linking
+   ability is needed to facilitate analysis and discussion of various aspects
+   of this reference code.