commit a7dafd6f194e81639c91e50d75f205343d02eef2
from: Sven M. Hallberg <pesco@khjk.org>
date: Fri Oct 27 09:19:45 2023 UTC

add toc section to README

commit - 5f021ff44f675e7c361c735a1273cddc9c92d2f9
commit + a7dafd6f194e81639c91e50d75f205343d02eef2
blob - 5dda78caf2a3786c51aded75f4c2426dadfce00c
blob + 7145a31facd0450aaf59b6a3f648199ea5191aa8
--- README
+++ README
@@ -56,4 +56,26 @@ Tips for learning:
    Whatever suits your needs.
 
 
-See NOTES for more background.
+Detailed table of contents:
+
+ morse.c
+	An extended version of classic /usr/games/morse that supports
+	audio output (-a) through sndio and integrates an interactive
+	teacher mode (-t) modeled after Cunningham's 1977 algorithm.
+ morseteach.c
+	Stand-alone teacher program that forks and uses 'morse -a' in the
+	background for its audio output.
+ morseplay.c
+	Stand-alone audio component to play morse code. Accepts dots and
+	dashes as 'morse -s' produces them.
+
+ teach.c
+	Implements the teacher algorithm. Used by morse and morseteach.
+ cw.c
+	Audio output routines for "continuous wave" tones of a given
+	frequency and length. Applies envelope functions for clean sound
+	without unwanted clicks. Used by morse and morseplay.
+
+ NOTES
+	Background research, plans, and history for the teacher algorithm,
+	other implementations, and the UNIX/BSD morse program.