From 971a0944083f84db8d19e52152b6b7a92b5ec0ca Mon Sep 17 00:00:00 2001
From: kevin <kevin@larke.org>
Date: Sat, 30 Nov 2024 08:46:51 -0500
Subject: [PATCH] README.md : More updates.

---
 README.md | 50 +++++++++++++++++++++++++++++++-------------------
 1 file changed, 31 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 06bbbc7..98a3d3f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# libcw Testing and Development App
+# cwtest Testing and Development Application for libcw.
+
+`cwtest` is a command line interface to `libcw`.  
 
 Command line:
 ```
@@ -22,30 +24,25 @@ Where `<file.cfg>` refers to a libcw configuration file file with the form:
 }
 ```
 
-`<label>` refers to a specific set of parameters which are associated with a library function.
-See `main.cpp` `mode_array[]` for the mapping of labels to functions.
+`<label>` refers to a specific set of named parameters
+(e.g. `program_0`,`program_1`) which are associated with a library
+function.  See `main.cpp` `mode_array[]` for the mapping of labels to
+functions.
 
-The goal of `cwtest` is to be able to easily exercize `libcw` functions with a flexible
-sets of parameters.  The configuration file provides the parameters.
+The goal of `cwtest` is to be able to easily exercise `libcw`
+functions, or build simple utilities based on them, with a flexible
+sets of parameters.  The primary parameter file is `src/cwtest/cfg/main.cfg`.
 
 
-## MIDI
+# MIDI
 
-# midiDeviceReport
+CLI Label         | Cfg File  | Notes
+------------------|-----------|----------------------------------------------------------------
+midiDeviceReport  | main.cfg  | List The current set of MIID hardware devices and their ports.
+midiDevice        |  "        | Interactive testing of the MIDI input file device start/pause/unpause/stop functions.
 
-List The current set of MIID hardware devices and their ports.
-```
-cwtest ~/src/cwtest/src/cwtest/cfg/main.cfg midiDeviceReport
-```
-
-# midiDevice
-
-Interactive testing of the MIDI input file device start/pause/unpause/stop functions.
-Compares the time between MIDI events as generated by the device to the actual time between the
+midiDevice :  Also Compares the time between MIDI events as generated by the device to the actual time between the
 events as listed in the file.
-```
-cwtest ~/src/cwtest/src/cwtest/cfg/main.cfg midiDevice
-```
 
 ## Serial
 
@@ -105,6 +102,21 @@ Generate a list of devices and device attributes from libcw.  This will include
 
 
 
+## socketUdp
+
+See test_udp() in `cwTcpSocketTest.cpp`.
+
+Interactive send/recv tester for UDP based sockets.  This tester can work across machines or
+on a single machine specifying '127.0.0.1' (localhost) as the remote address and choosing different
+port numbers for the remote and local address.  
+
+## socketUdp
+
+See test_udp() in `cwTcpSocketTest.cpp`.
+
+Interactive send/recv tester for TCP based sockets.  This tester can work across machines or
+on a single machine specifying '127.0.0.1' (localhost) as the remote address and choosing different
+port numbers for the remote and local address.