From 395f042288b6891e9bb61d6e5ebddc2d24d69ce6 Mon Sep 17 00:00:00 2001 From: Jonathan Naylor Date: Fri, 10 Jun 2016 11:32:54 +0100 Subject: [PATCH] Update the README based on development. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 84c4f7f..e17306c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ -These programs represent simple clients for the System Fusion networking now built into the MMDVM Host. The parrot can be used as a functional replacement for the built-in parrot that was removed when the networking was added. +These programs are clients for the System Fusion networking now built into the MMDVM Host. -The reflector is a simple minded reflector that retransmits any received System Fusion data to other MMDVM Hosts logged into the reflector at the time. +The Parrot can be used as a functional replacement for the built-in parrot that was removed from the MMDVM Host when the networking was added. The Parrot is very simple minded and can only handle one client at a time and is therefore not suitable for use as a shared resource via the Internet. -Both programs take the UDP port number to listen on as an argument. The MMDVM .ini file should have the IP address and port number of the client in the [System Fusion Network] settings. +The Gateway allows for use of Yaesu Wires-X commands from the radio to control the listing and access to the various reflectors (rooms in Wires-X parlance). It optionally sends System Fusion GPS information to aprs.fi. -It builds on 32-bit and 64-bit Linux as well as on Windows using VS2015 on x86 and x64. It can optionally control various Displays. Currently these are: +The Reflector retransmits any received System Fusion data to other MMDVM Hosts or Gateways logged into the reflector at the time. It also provides status information to potential clients. + +The Gateway and Reflector have ini files that contain the parameters for running the software. The filename of the ini file is passed as a parameter on the command line. The Parrot takes the UDP port number to listen on as an argument. + +The MMDVM .ini file should have the IP address and port number of the client in the [System Fusion Network] settings. + +They build on 32-bit and 64-bit Linux as well as on Windows using VS2015 on x86 and x64. This software is licenced under the GPL v2 and is intended for amateur and educational use only. Use of this software for commercial purposes is strictly forbidden.