changeset 8:7e2b24fc097b

add README and INSTALL
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 27 May 2024 22:09:00 +0000
parents b97024a897c3
children 3e88515bcc6d
files INSTALL README
diffstat 2 files changed, 18 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/INSTALL	Mon May 27 22:09:00 2024 +0000
@@ -0,0 +1,8 @@
+The new split-components version of Themyscira Wireless software uses configure
+scripts - you need to run ./configure before running 'make'.  However, our
+configure script is hand-coded, not Autotools/autohell, hence there is no
+autoreconf nonsense involved.
+
+Standard --prefix, --exec-prefix, --bindir, --includedir and --libdir options
+are supported for changing installation directories; the default prefix is
+/usr/local, following general FOSS community conventions.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Mon May 27 22:09:00 2024 +0000
@@ -0,0 +1,10 @@
+The software component in this repository is themwi-rtp-mgr, a part of
+Themyscira Wireless system software.  It is a daemon process that allocates
+RTP+RTCP port pairs (consecutive even+odd UDP ports) for other ThemWi components
+that need RTP endpoints.  This package provides the daemon process itself, the
+header file defining the interface to it (UNIX domain socket), library functions
+(and their associated header files) for using the RTP allocator service, and
+some miscellaneous header files with general RTP definitions.
+
+This package is a dependency for themwi-mgw, sipout-test-utils and likely other
+Themyscira software in the future.