summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README61
1 files changed, 61 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..bdd2aa1
--- /dev/null
+++ b/README
@@ -0,0 +1,61 @@
+cwsnd & kochgen
+version 0.9.0
+
+CW Training Suite for OpenBSD, following the UNIX philosophy.
+
+
+ABOUD CWSND
+-----------
+cwsnd is a CW/Morse code sounder written for OpenBSD using the sndio
+API. The primary use case for this program is for CW ham study
+purposes, although it can be used for computer keying with suitable
+hardware, similar to FLDigi Tx using sound card audio output.
+
+More information can be found in the manpage (man ./cwsnd.1)
+
+(Currently only OpenBSD is supported. At the present moment, the
+author does not want to deal with the Linux audio hellscape.)
+
+
+ABOUT KOCHGEN
+-------------
+kochgen is a simple utility to generate a word list based on a
+character set. It can be used for Koch or Koch--Farnsworth training
+when piped into cwsnd.
+
+More information can be found in the manpage (man ./kochgen.1)
+
+
+INSTALLATION
+------------
+To compile:
+
+ $ make
+
+To install the binaries as root:
+
+ # make install
+
+Use the PREFIX variable to install somewhere other than /usr/local:
+
+ $ PREFIX=/home/me/.local make install
+
+Run this as root to install the manpages:
+
+ # make installdoc
+
+Other install targets: install-cwsnd install-kochgen installdoc-cwsnd
+installdoc-kochgen uninstall uninstall-cwsnd uninstall-kochgen
+
+
+AUTHOR
+------
+Samuel Wirajaya
+
+
+DISCLAIMER
+----------
+This software is provided "as is" with no warranty from the author.
+If you do use this program for actual radio transmission, bear in mind
+that you are ultimately responsible for whatever is coming out of your
+antenna. See the LICENSE file for details.