Documentation in English

Made-with: Cursor

README.md

@@ -1,77 +1,77 @@
 # HotKeet
 
-Push-to-Talk Diktier-App mit Offline-Spracherkennung. Hotkey gedrückt = aufnehmen, losgelassen = stoppen, transkribieren, einfügen.
+Push-to-Talk dictation app with offline speech recognition. Hold hotkey = record, release = stop, transcribe, paste.
 
-## Übersicht
+## Overview
 
-| Komponente | Beschreibung |
-|------------|--------------|
-| **HotKeet** | GUI-App: Aufnahme, Transkription, Texteinfügung per Hotkey |
-| **parakeet-cli** | CLI für Parakeet v3 Speech-to-Text (transcribe-rs) |
+| Component | Description |
+|-----------|-------------|
+| **HotKeet** | GUI app: recording, transcription, text insertion via hotkey |
+| **parakeet-cli** | CLI for Parakeet v3 Speech-to-Text (transcribe-rs) |
 
-## Schnellstart
+## Quick Start
 
-### Voraussetzungen
+### Prerequisites
 
 - Rust (1.70+)
-- **parakeet-cli** muss gebaut und erreichbar sein (im PATH oder Pfad konfigurieren)
-- Parakeet-Modell (z.B. `parakeet-tdt-0.6b-v3-int8`)
+- **parakeet-cli** must be built and available (in PATH or configure path)
+- Parakeet model (e.g. `parakeet-tdt-0.6b-v3-int8`)
 
 ### Build
 
 ```bash
-# parakeet-cli zuerst bauen
+# Build parakeet-cli first
 cd parakeet-cli
 cargo build --release
 
-# HotKeet bauen
+# Build HotKeet
 cd ../HotKeet
 cargo build --release
-# oder unter Windows: build.cmd
+# or on Windows: build.cmd
 ```
 
-### Erste Schritte
+### First Steps
 
-1. HotKeet starten – läuft im Tray
-2. Rechtsklick auf Tray-Icon → **Einstellungen**
-3. **parakeet-cli** und **Modellpfad** per „Durchsuchen…“ auswählen (oder leer lassen = Standard)
-4. **Mikrofon** wählen
-5. **Speichern**
+1. Start HotKeet – runs in system tray
+2. Right-click tray icon → **Settings**
+3. Select **parakeet-cli** and **model path** via "Browse…" (or leave empty = default)
+4. Choose **microphone**
+5. **Save**
 
-Standard-Hotkey: **Ctrl+Shift+D** (drücken = Aufnahme, loslassen = Transkription + Einfügen)
+Default hotkey: **Ctrl+Shift+D** (hold = record, release = transcribe + paste)
 
-## Konfiguration
+## Configuration
 
-| Einstellung | Beschreibung |
-|-------------|-------------|
-| **Hotkey** | Globaler Push-to-Talk (z.B. Ctrl+Shift+D) |
-| **Eingabequelle** | Companion-App oder Mikrofon |
-| **parakeet-cli Pfad** | Leer = im PATH (Standard: parakeet-cli) |
-| **Modellpfad** | Leer = Standardpfad (plattformabhängig) |
-| **Einfügemethode** | Auto | Tastaturpuffer | Zwischenablage |
+| Setting | Description |
+|---------|-------------|
+| **Hotkey** | Global Push-to-Talk (e.g. Ctrl+Shift+D) |
+| **Input source** | Companion app or microphone |
+| **parakeet-cli path** | Empty = in PATH (default: parakeet-cli) |
+| **Model path** | Empty = default path (platform-dependent) |
+| **Paste method** | Auto | Keyboard buffer | Clipboard |
 
-**Speicherort:** `%LOCALAPPDATA%\HotKeet\settings.json` (Windows) bzw. `~/.config/HotKeet/settings.json` (Linux/macOS)
+**Storage location:** `%LOCALAPPDATA%\HotKeet\settings.json` (Windows) or `~/.config/HotKeet/settings.json` (Linux/macOS)
 
-## Plattformen
+## Platforms
 
-| Plattform | Status |
-|-----------|--------|
-| **Windows** | ✅ Voll unterstützt |
-| **Linux** | ⚠️ Lauffähig (Tray: libappindicator) |
-| **macOS** | ⚠️ Lauffähig |
+| Platform | Status |
+|----------|--------|
+| **Windows** | ✅ Fully supported |
+| **Linux** | ⚠️ Runs (Tray: libappindicator) |
+| **macOS** | ⚠️ Runs |
 
 Details: [HotKeet/PLATFORM.md](HotKeet/PLATFORM.md)
 
-## Projektstruktur
+## Project Structure
 
 ```
 HotKeet/
-├── HotKeet/          # Diktier-App (Rust, egui)
-├── parakeet-cli/     # Transkriptions-CLI (Rust, ONNX)
+├── HotKeet/          # Dictation app (Rust, egui)
+├── parakeet-cli/     # Transcription CLI (Rust, ONNX)
 ├── LICENSE           # MIT
 └── README.md
 ```
 
-## Lizenz
+## License
 
 [MIT License](LICENSE)