Config-Pfad HotKeet, README, MIT-Lizenz

- Einstellungen: %LOCALAPPDATA%\HotKeet (statt hotkeet)
- README.md mit Schnellstart, Konfiguration, Projektstruktur
- MIT-Lizenz (LICENSE)
- Cursor-Regel für README-Pflege

Made-with: Cursor
This commit is contained in:
2026-03-06 19:45:50 +01:00
parent e7cc3fbb50
commit f093a06f23
5 changed files with 121 additions and 7 deletions

77
README.md Normal file
View File

@@ -0,0 +1,77 @@
# HotKeet
Push-to-Talk Diktier-App mit Offline-Spracherkennung. Hotkey gedrückt = aufnehmen, losgelassen = stoppen, transkribieren, einfügen.
## Übersicht
| Komponente | Beschreibung |
|------------|--------------|
| **HotKeet** | GUI-App: Aufnahme, Transkription, Texteinfügung per Hotkey |
| **parakeet-cli** | CLI für Parakeet v3 Speech-to-Text (transcribe-rs) |
## Schnellstart
### Voraussetzungen
- 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`)
### Build
```bash
# parakeet-cli zuerst bauen
cd parakeet-cli
cargo build --release
# HotKeet bauen
cd ../HotKeet
cargo build --release
# oder unter Windows: build.cmd
```
### Erste Schritte
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**
Standard-Hotkey: **Ctrl+Shift+D** (drücken = Aufnahme, loslassen = Transkription + Einfügen)
## Konfiguration
| 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 |
**Speicherort:** `%LOCALAPPDATA%\HotKeet\settings.json` (Windows) bzw. `~/.config/HotKeet/settings.json` (Linux/macOS)
## Plattformen
| Plattform | Status |
|-----------|--------|
| **Windows** | ✅ Voll unterstützt |
| **Linux** | ⚠️ Lauffähig (Tray: libappindicator) |
| **macOS** | ⚠️ Lauffähig |
Details: [HotKeet/PLATFORM.md](HotKeet/PLATFORM.md)
## Projektstruktur
```
HotKeet/
├── HotKeet/ # Diktier-App (Rust, egui)
├── parakeet-cli/ # Transkriptions-CLI (Rust, ONNX)
├── LICENSE # MIT
└── README.md
```
## Lizenz
[MIT License](LICENSE)