feat: new readme

This commit is contained in:
leonardotrapani
2026-02-01 22:04:42 +01:00
parent 0b0e084155
commit 305f64a73d
16 changed files with 517 additions and 685 deletions
+11
View File
@@ -2,12 +2,23 @@
This document covers manual configuration of hyprvoice via the `config.toml` file. For most users, the interactive wizard is recommended:
```bash
hyprvoice onboarding
```
To adjust settings later:
```bash
hyprvoice configure
```
Configuration is stored in `~/.config/hyprvoice/config.toml` and changes are applied immediately without restarting the daemon.
## Onboarding vs Configure
- `hyprvoice onboarding`: guided first-time setup for provider keys, voice model, language/streaming, LLM post-processing, keywords, and notifications. Advanced settings stay at defaults.
- `hyprvoice configure`: full TUI menu for all sections, including advanced recording, injection backends, timeouts, and notification messages.
## Table of Contents
- [Unified Provider System](#unified-provider-system)