From 61d8671691631e101ca0037d7ddaa9e0246a07d1 Mon Sep 17 00:00:00 2001 From: Jonathan Naylor Date: Fri, 22 Sep 2017 20:29:05 +0100 Subject: [PATCH] Upgrade the README file considerably. --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a7edbf0..b6d6575 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -These are simple networking clients for P25 that work with the MMDVM Host. +These programs are clients for the P25 networking now built into the MMDVM Host. -Two programs exist. A simple gateway and a parrot program. +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. + +The Gateway allows for use of P25 Talk Groups to control the access to the various P25 reflectors. + +The Gateway has an ini file 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 [P25 Network] settings. + +They build on 32-bit and 64-bit Linux as well as on Windows using Visual Studio 2017 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.