# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1713375025 0
# Node ID 8b17df8f63404a3d54886495c4aca3e920009500
# Parent  1fd613cec7ab0d1793eaa1d3b22ca82de93f4f91
add README

diff -r 1fd613cec7ab -r 8b17df8f6340 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed Apr 17 17:30:25 2024 +0000
@@ -0,0 +1,9 @@
+This code repository contains the original GSM-EFR reference code from ETSI
+(taken from ts_146053v080000p0.zip), plus some small surgical patches (grafts
+of code from AMR reference source) conditionalized with #ifdef EFR2_VARIANT.
+In std directory we build the standard version of ETSI EFR encoder and decoder
+(no hacks applied), and in efr2 directory we build our experimental hack
+versions with -DEFR2_VARIANT.
+
+Please read the accompanying Theory-and-mystery article for an explanation of
+what the fuss is all about.