Polish onboarding flow docs and retry acceptance tests
This commit is contained in:
parent
992d22a138
commit
ed950cb7c4
2 changed files with 47 additions and 4 deletions
15
README.md
15
README.md
|
|
@ -64,11 +64,17 @@ uv sync --extra x11
|
|||
## Quickstart
|
||||
|
||||
```bash
|
||||
uv run python3 src/aman.py init
|
||||
uv run python3 src/aman.py doctor
|
||||
uv run python3 src/aman.py run
|
||||
```
|
||||
|
||||
On first launch, Aman opens a graphical setup wizard automatically.
|
||||
The wizard asks for:
|
||||
|
||||
- microphone input
|
||||
- hotkey
|
||||
- output backend
|
||||
- writing profile
|
||||
|
||||
## Config
|
||||
|
||||
Create `~/.config/aman/config.json` (or let `aman` create it automatically on first start if missing):
|
||||
|
|
@ -165,7 +171,8 @@ Service notes:
|
|||
- `Esc` is only captured during active recording.
|
||||
- Recording start is aborted if the cancel listener cannot be armed.
|
||||
- Transcript contents are logged only when `-v/--verbose` is used.
|
||||
- Tray menu includes: `Pause/Resume Aman`, `Reload Config`, `Run Diagnostics`, `Open Config Path`, and `Quit`.
|
||||
- Tray menu includes: `Setup Aman...`, `Pause/Resume Aman`, `Reload Config`, `Run Diagnostics`, `Open Config Path`, and `Quit`.
|
||||
- If setup is not completed, Aman enters a `Setup Required` tray mode and does not capture audio.
|
||||
|
||||
Wayland note:
|
||||
|
||||
|
|
@ -189,7 +196,7 @@ make doctor
|
|||
make check
|
||||
```
|
||||
|
||||
CLI:
|
||||
CLI (internal/support fallback):
|
||||
|
||||
```bash
|
||||
uv run python3 src/aman.py run --config ~/.config/aman/config.json
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue