summaryrefslogtreecommitdiff
path: root/README
blob: bdd2aa147d2d1861d61c331c56c5b8a689e537ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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.