docs: update documentation for latest changes
- Add stt-ptt language support documentation - Add rofi-project-opener module documentation - Add rofi-project-opener package documentation - Update zellij-ps documentation - Update guides and reference patterns - Update AGENTS.md with latest commands
This commit is contained in:
@@ -104,6 +104,42 @@ Notification timeout in milliseconds for the recording indicator.
|
||||
- Default: `3000`
|
||||
- Example: `5000` (5 seconds), `0` (persistent)
|
||||
|
||||
### `cli.stt-ptt.language`
|
||||
|
||||
Language for speech recognition. Use "auto" for automatic language detection, or specify a language code for better accuracy.
|
||||
|
||||
- Type: `enum ["auto", "en", "es", "fr", "de", "it", "pt", "ru", "zh", "ja", "ko", "ar", "hi", "tr", "pl", "nl", "sv", "da", "fi", "no", "vi", "th", "id", "uk", "cs"]`
|
||||
- Default: `"auto"`
|
||||
|
||||
**Auto-detection**: When set to "auto", whisper.cpp analyzes the audio to determine the spoken language automatically.
|
||||
|
||||
**Language specification**: Specifying a language code improves transcription accuracy if you know the language in advance.
|
||||
|
||||
```nix
|
||||
# Automatic language detection (default)
|
||||
language = "auto";
|
||||
|
||||
# Force English transcription
|
||||
language = "en";
|
||||
|
||||
# Spanish transcription
|
||||
language = "es";
|
||||
```
|
||||
|
||||
**Common language codes:**
|
||||
|
||||
| Code | Language |
|
||||
|------|----------|
|
||||
| `en` | English |
|
||||
| `es` | Spanish |
|
||||
| `fr` | French |
|
||||
| `de` | German |
|
||||
| `zh` | Chinese |
|
||||
| `ja` | Japanese |
|
||||
| `ko` | Korean |
|
||||
|
||||
whisper.cpp supports 100+ languages. See whisper.cpp documentation for the full list.
|
||||
|
||||
## Usage
|
||||
|
||||
After enabling, bind `stt-ptt start` and `stt-ptt stop` to a key:
|
||||
@@ -166,6 +202,16 @@ cli.stt-ptt = {
|
||||
};
|
||||
```
|
||||
|
||||
### Language-Specific Transcription
|
||||
|
||||
```nix
|
||||
cli.stt-ptt = {
|
||||
enable = true;
|
||||
model = "ggml-large-v3-turbo";
|
||||
language = "es"; # Force Spanish transcription
|
||||
};
|
||||
```
|
||||
|
||||
### High Quality with NVIDIA GPU
|
||||
|
||||
```nix
|
||||
@@ -221,6 +267,7 @@ The module sets these automatically:
|
||||
| Variable | Value |
|
||||
|----------|-------|
|
||||
| `STT_MODEL` | `~/.local/share/stt-ptt/models/<model>.bin` |
|
||||
| `STT_LANGUAGE` | Configured language ("auto" by default) |
|
||||
| `STT_NOTIFY_TIMEOUT` | Configured timeout in ms |
|
||||
|
||||
## Requirements
|
||||
|
||||
Reference in New Issue
Block a user