vqbe/morse-trainer
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: updated readme

Browse Source
This commit is contained in:
Alberto Rigamonti
2025-11-21 16:22:20 +01:00
parent b446190abe
commit 64119550f0
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -6,13 +6,15 @@ A terminal-based morse code practice game built with Deno. Improve your morse co
- **Multiple Difficulty Modes** - **Multiple Difficulty Modes**
- 🟢 Easy: Single letters (A-Z) - 🟢 Easy: Single letters (A-Z)
- 🟡 Medium: Single numbers (0-9) - 🟡 Medium: Letters + Numbers (A-Z, 0-9)
- 🟣 Hard: Common words - 🟣 Hard: Letters + Numbers + Punctuation (.,?!-/()@)
- 🔵 Challenge: Common words
- 🔴 Expert: Short phrases - 🔴 Expert: Short phrases
- **Interactive TUI Interface** - **Interactive TUI Interface**
- Beautiful terminal UI with colors and tables - Beautiful terminal UI with colors and tables
- Real-time timer for each round - Configurable time limits (3-60 seconds)
- Dynamic time option for words/phrases (time scales with length)
- Immediate feedback on answers - Immediate feedback on answers
- Progress tracking with streak counter - Progress tracking with streak counter
@@ -72,7 +74,7 @@ deno task start play --mode phrases --rounds 10 --time 45
``` ```
Options: Options:
- `-m, --mode <mode>` - Game mode: `letters`, `numbers`, `words`, or `phrases` (default: letters) - `-m, --mode <mode>` - Game mode: `letters`, `alphanumeric`, `full`, `words`, or `phrases` (default: letters)
- `-r, --rounds <number>` - Number of rounds (default: 10) - `-r, --rounds <number>` - Number of rounds (default: 10)
- `-t, --time <seconds>` - Seconds per round (default: 30) - `-t, --time <seconds>` - Seconds per round (default: 30)
@@ -98,24 +100,31 @@ deno task start reset
## How to Play ## How to Play
1. **Select a difficulty mode** - Choose from letters, numbers, words, or phrases 1. **Select a difficulty mode** - Choose from:
2. **Configure your game** - Set the number of rounds and time per round - Letters only (A-Z)
3. **Translate to morse code** - You'll be shown a challenge (letter, number, word, or phrase) - Alphanumeric (A-Z, 0-9)
4. **Enter your answer** - Type the morse code using: - Full character set (letters, numbers, punctuation)
- Words or phrases
2. **Configure your game** - Set the number of rounds (5-50) and time per round (3-60 seconds)
3. **Enable dynamic time (optional)** - For words/phrases, time can scale based on character count
4. **Translate to morse code** - You'll be shown a challenge
5. **Enter your answer** - Type the morse code using:
- `.` (dot) for short signals - `.` (dot) for short signals
- `-` (dash) for long signals - `-` (dash) for long signals
- Space to separate letters - Space to separate letters
- `/` to separate words - `/` to separate words
5. **Get instant feedback** - See if you got it right and track your streak 6. **Get instant feedback** - See if you got it right and what your input translates to if wrong
6. **Review your performance** - After all rounds, view detailed statistics 7. **Review your performance** - After all rounds, view detailed statistics
## Morse Code Basics ## Morse Code Basics
- Use `.` for dots and `-` for dashes - Use `.` for dots and `-` for dashes
- Separate letters with spaces - Separate letters with spaces
- Use `/` for word boundaries - Use `/` for word boundaries
- Supported punctuation: `. , ? ! - / ( ) @`
- Example: `HELLO` = `.... . .-.. .-.. ---` - Example: `HELLO` = `.... . .-.. .-.. ---`
- Example: `SOS` = `... --- ...` - Example: `SOS` = `... --- ...`
- Example: `HELLO WORLD` = `.... . .-.. .-.. --- / .-- --- .-. .-.. -..`
## Statistics ## Statistics