# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1728702677 0
# Node ID 3ae4a6ca56390ae43c235928b6782818d5f317f8
# Parent  1dacfe7d5b3dbeb3bf37c0d41cbbc01c27237c91
add README

diff -r 1dacfe7d5b3d -r 3ae4a6ca5639 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Oct 12 03:11:17 2024 +0000
@@ -0,0 +1,9 @@
+The project contained in this repository is a mechanism for capturing the
+decoded 16-bit linear PCM form of voice call downlink on FreeCalypso boards
+via MCSI, and for feeding 16-bit linear PCM into call uplink via the same
+interface.  The mechanism consists of a Lattice Icestick FPGA board, a gateware
+image for this FPGA, and host programs that interface to it via the UART channel
+of the on-board FT2232H.
+
+So far only downlink Rx has been implemented; to get the uplink path, more work
+is needed on both FPGA gateware and software components.