From d2b48e7c9317f8811ca9702289349db23b4b67aa Mon Sep 17 00:00:00 2001 From: Hannes Matuschek Date: Thu, 12 Jul 2018 13:24:42 +0200 Subject: [PATCH 1/2] Updated readme. --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 45852f6..85f47fc 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ KochMorse is a simple morse-code tutor using the [Koch method](http://www.qsl.net/n1irz/finley.morse.html). It is written in C++ and uses -[Qt5](https://qt-project.org) for the graphical user interface (GUI) and -[PortAudio](http://www.portaudio.com/) as its audio backend. +[Qt5](https://qt-project.org) for the graphical user interface (GUI). Koch Morse in action. @@ -18,7 +17,11 @@ are new features compared to the "old" python implementation. * *A simplified GUI* -- All settings are now accessible via the Preferences dialog. * A morse tutor using the Koch method (of course). * *A random morse tutor* -- Allows to select a set of characters and prosigns for practicing. - * *A QSO tutor* -- Selects a random QSO from a set of over 900 for practicing. + * *A QSO tutor* -- Generates a random QSO text so you can practice reading typical QSOs. + * *A transmit tutor* -- Connect your practice tone-generator to your microphone input and check your + transmissions with KochMorse. + * *A chat tutor* -- This tutor is a combination of the transmit tutor and the QSO tutor. Call CQ + and KochMorse will answer. * Different speed of characters and pauses. This allows to practice the reading in full speed, while having enough time to write the character down. * *Different tones for dashes and dots.* @@ -28,6 +31,7 @@ are new features compared to the "old" python implementation. ## Releases + * 2017-06-12 - [**Version 3.3.0**](https://github.com/hmatuschek/kochmorse/releases/tag/v3.3.0) * 2015-06-30 - [**Version 3.2.2**](https://github.com/hmatuschek/kochmorse/releases/tag/v3.2.2) * 2015-02-28 - [**Version 3.2.1**](https://github.com/hmatuschek/kochmorse/releases/tag/v3.2.1) * 2015-02-22 - [**Version 3.2.0**](https://github.com/hmatuschek/kochmorse/releases/tag/v3.2.0) @@ -37,8 +41,14 @@ are new features compared to the "old" python implementation. ## History -This is a C++/Qt reimplementation of my "old" python morse-code tutor (also called "kochmorse", https://kochmorse.googlecode.com). As the "old" implementation relied on ALSA for sound output, it was restricted to Linux. This reimplementation now uses PortAudio for the sound output and the GUI is implemented using Qt5, it is therefore more platform independent and runs under Linux, MacOS X and Windows. +This is a C++/Qt reimplementation of my "old" python morse-code tutor (also called "kochmorse", +https://kochmorse.googlecode.com). As the "old" implementation relied on ALSA for sound output, +it was restricted to Linux. This reimplementation now uses PortAudio for the sound output and the +GUI is implemented using Qt5, it is therefore more platform independent and runs under Linux, +MacOS X and Windows. -For this reimplementation, I simplified the GUI a lot. All settings are now "hidden" in a preferences dialog. All features of the "old" version are now present in this one and even some more... +For this reimplementation, I simplified the GUI a lot. All settings are now "hidden" in a +preferences dialog. All features of the "old" version are now present in this one and even some +more... From 2c4955ddf874048b770d4d03b5a3d382f532f1e1 Mon Sep 17 00:00:00 2001 From: Hannes Matuschek Date: Thu, 12 Jul 2018 13:30:13 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 85f47fc..970497b 100644 --- a/README.md +++ b/README.md @@ -11,22 +11,22 @@ KochMorse runs under Linux, MacOS X and even under Windows. See the ## Features -Below, you will find a list of features of the current KochMorse release. The highlighted features -are new features compared to the "old" python implementation. - - * *A simplified GUI* -- All settings are now accessible via the Preferences dialog. - * A morse tutor using the Koch method (of course). - * *A random morse tutor* -- Allows to select a set of characters and prosigns for practicing. - * *A QSO tutor* -- Generates a random QSO text so you can practice reading typical QSOs. - * *A transmit tutor* -- Connect your practice tone-generator to your microphone input and check your +Below, you will find a list of features of the current KochMorse release. + + * A morse tutor using the Koch method. + * A random morse tutor -- Allows to select a set of characters and prosigns for practicing. + * A QSO tutor -- Generates a random QSO text so you can practice reading typical QSOs. + * Customized text tutor -- This tutor allows you to listen to a plain-text file or to a text + [generated](https://github.com/hmatuschek/kochmorse/wiki/TextGen) from a user-defined rules. + * A transmit tutor -- Connect your practice tone-generator to your microphone input and check your transmissions with KochMorse. - * *A chat tutor* -- This tutor is a combination of the transmit tutor and the QSO tutor. Call CQ + * A chat tutor -- This tutor is a combination of the transmit tutor and the QSO tutor. Call CQ and KochMorse will answer. * Different speed of characters and pauses. This allows to practice the reading in full speed, while having enough time to write the character down. - * *Different tones for dashes and dots.* - * *Noise audio effect* -- Increases the difficulty to read the morse code for practicing. - * *Fading audio effect* -- Periodically fades the morse signal for practicing. In conjecture with + * Different tones for dashes and dots. + * Noise audio effect -- Increases the difficulty to read the morse code for practicing. + * Fading audio effect -- Periodically fades the morse signal for practicing. In conjecture with the noise effect, it simulates the conditions on HF bands pretty well. @@ -47,8 +47,4 @@ it was restricted to Linux. This reimplementation now uses PortAudio for the sou GUI is implemented using Qt5, it is therefore more platform independent and runs under Linux, MacOS X and Windows. -For this reimplementation, I simplified the GUI a lot. All settings are now "hidden" in a -preferences dialog. All features of the "old" version are now present in this one and even some -more... -