Add README.md

fritzsche · Nov 25, 2024 · f2b76ea · f2b76ea
1 parent 7645be2
commit f2b76ea
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,84 @@
-# WebMorseRunner
- Morse Contest Practice
+# Web Morse Runner
+
+A small contest simulator for the web.
+
+## About 
+This is a new written version of MorseRunner as Web-Application. 
+
+The Project is inspired by the Program [MorseRunner by VE2NEA - Alex Shovkoplyas](https://github.com/VE3NEA/MorseRunner). The Idea to start a complete new Web App Project originate from the authors previous effort to [port MorseRunner to Linux and Mac](https://github.com/fritzsche/MorseRunner).
+
+
+This project is complete new and independent of Alex project. The original MorseRunner target Windows and is developed in Pascal, while this version is complete rewritten from scratch in Javascript and targeting the usage in web browsers. 
+
+
+
+
+## Functions
+
+* Runs in Browser using Javascript
+* Usage Web Audio API using AudioWorklet
+* No Backend
+* Single Call Mode (yet)
+* (Complex) Noise
+* Modulation
+* Filter
+* Read List of calls from calls.txt
+* Speed in WPM
+* Stetting: 
+    * Pitch
+    * RX Bandwidth
+    * Monitor Level
+    * RIT
+    * Time the contest should run
+    * My Call
+* Sending via buttons and function key 
+* ESM (Enter to Send Message)
+* Calculate and display Score
+* Display log and confirm QSO's
+
+## Features not (yet) implemented
+
+* Other contest modes (e.g. Pile-up/WPX)
+* Bank Condition (QRM/QRN etc.)
+* WAV File Export
+* Best-List
+* Score over time
+* some Keyboard shortcuts missing
+
+## Status
+This Web App is in a very early stage, still searching some bugs and optimizations. 
+The App can work, but consider this app as experimental.
+
+## Usage
+Web Morse Runner is a contest simulator. The target is to get as much points(QSO's) and multis(Prefix) as possible.
+
+Start my setting the parameters, like your call sign, preferred WPM etc. and start the contest by pressing the run button.
+
+Station will call you and you need to log the QSO in the fields Call/NR. 
+Currently this app only supports the single call contest mode. This means only one station will call you at the same time and the calls are coming without the need to call CQ.
+
+Use the respective buttons or function key to respond to the stations. You need to end the QSO by sending TU. 
+
+The simulator supports ESM (Enter to Send Message), means hitting the Enter key will allow you to send messages depending on the state of the QSO.
+
+
+## Version
+
+* 0.1-alpha (2024-11-25) initial public release.
+
+## References
+* [Morse Runner](https://github.com/VE3NEA/MorseRunner) (Windows/Pascal) by VE2NEA - Alex Shovkoplyas
+* [Morse Runner Community Edition](https://groups.io/g/MorseRunnerCE)
+* [Morse Runner Port](https://github.com/fritzsche/MorseRunner) (Linux/Mac) adopted by DJ1TF  - Thomas Fritzsche
+
+
+## Thanks
+Like to thank VE2NEA Alex Shovkoplyas for his inspiring work on MorseRunner.
+
+
+
+
+73, Thomas - DJ1TF
+
+
 
-This is a experimental project. 
diff --git a/index.html b/index.html
@@ -9,7 +9,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <meta name="theme-color" content="#000000" />
   <link rel="stylesheet" href="style.css" type="text/css" media="screen" />
-  <title>Web Morse Runner</title>
+  <title>Web Morse Runner by DJ1TF - Thomas Fritzsche</title>
 </head>
 
 <body>
@@ -31,6 +31,8 @@
       <div id="title">
         <div class="large"> Web Morse Runner 0.1&alpha;</div>
         <div> by DJ1TF - Thomas Fritzsche</div>
+        <div> <a href="https://github.com/fritzsche/WebMorseRunner">Github Project</a>          
+        </div>
       </div>
     </div>
     <div>

diff --git a/style.css b/style.css
@@ -228,3 +228,6 @@ fieldset {
   width: 100%;
 }
 
+#title a {
+  color: rgb(28, 161, 202);
+}