# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1717909235 0
# Node ID 047bb5a91709759895aaf635bc29df4c9fd43baf
# Parent  aa2ba9b432af2e047b79067d04ad0d429a3b4fe3
add README

diff -r aa2ba9b432af -r 047bb5a91709 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun Jun 09 05:00:35 2024 +0000
@@ -0,0 +1,23 @@
+This code repository holds a version of Themyscira Wireless circuit-switched
+network components that is newer than the original one, but still not the
+long-term-goal themwi-csw version - hence interim.  The key properties of this
+interim version are as follows:
+
+* current themwi-nanp and themwi-rtp-mgr packages are used as dependencies,
+  no more local K&R C libraries/utilities for these functions;
+
+* the required version of OsmoMSC is still the one based on 2023-02 release,
+  branch falconia/production or falconia/prod-newlib in the official osmo-msc
+  git repository.
+
+When the new version of themwi-mgw becomes a reality, the present "interim"
+suite will include themwi-sip-in and themwi-sip-out daemons that work with
+the old OsmoMSC, but use the new themwi-mgw.  Until then, the two components
+maintained here are:
+
+* themwi-mncc daemon: works with the old OsmoMSC, but uses current themwi-nanp
+  libraries;
+
+* themwi-test-mtc command line utility: works with the old OsmoMSC through
+  themwi-mncc, but uses themwi-rtp-mgr for RTP allocation (instead of old
+  themwi-mgw) and features RTP play command.