README rewritten to lead with the push-to-talk setup script as the main feature, with the full OpenWhispr installer demoted to an optional collapsed section. Documents known Linux bugs in OpenWhispr (Hold mode, Ctrl+Super, settings persistence). CHANGELOG updated with v1.1.0 entry. https://claude.ai/code/session_01XKYC1basxdwtHy71tky7xm
53 lines
2.1 KiB
Markdown
53 lines
2.1 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/).
|
|
|
|
## [1.1.0] — 2026-03-26
|
|
|
|
### Added
|
|
|
|
- **Push-to-talk setup script** `setup-ptt.sh` — one-command PTT setup
|
|
- Interactive hotkey selection (Ctrl+Alt, Ctrl+Shift, Alt+Shift, Right Ctrl, Right Alt)
|
|
- Generates PTT Python script using `evdev` for reliable key detection
|
|
- Creates systemd user service (auto-start, restart on failure)
|
|
- Adds user to `input` group (no sudo needed for PTT)
|
|
- Checks if OpenWhispr is running, offers to launch
|
|
- Creates uninstall script
|
|
- PTT script `openwhispr-ptt.py` using `evdev` for physical key events
|
|
- Filters key repeats (evdev value=2) — no rapid-fire toggling
|
|
- Skips virtual keyboards (ydotoold)
|
|
- Clean xdotool keyup/keydown sequence for reliable Ctrl+` delivery
|
|
|
|
### Changed
|
|
|
|
- README restructured — PTT workaround is now the primary focus
|
|
- Original installer (`setup-openwhispr.sh`) moved to optional/secondary
|
|
|
|
### Fixed
|
|
|
|
- Script works when run via `bash <(curl ...)` — all reads use `/dev/tty`
|
|
- Script wrapped in `main()` to prevent line-by-line execution bug
|
|
- Binary detection searches `/opt/`, `/usr/lib/`, `dpkg -L` paths
|
|
- Replaced `YOUR_USERNAME` placeholder with `outis1one`
|
|
|
|
## [1.0.0] — 2026-03-25
|
|
|
|
### Added
|
|
|
|
- Single-file bash installer `setup-openwhispr.sh`
|
|
- Automatic distro detection (Ubuntu, Debian, Mint, Fedora, openSUSE, Arch)
|
|
- Architecture detection (amd64, arm64)
|
|
- GitHub releases integration — fetches latest OpenWhispr automatically
|
|
- Paste dependency detection (xdotool / kdotool / wtype / D-Bus)
|
|
- STT provider selection: local Whisper/Parakeet, Groq, OpenAI Realtime
|
|
- AI cleanup provider selection: OpenAI, Anthropic, Groq, Ollama, skip
|
|
- Safe API key storage in `~/.bashrc` (never overwrites existing keys)
|
|
- Idempotent — safe to re-run, skips already-installed versions
|
|
- ShellCheck CI via GitHub Actions
|
|
- README with cost table, privacy table, and one-command install
|
|
- Issue templates for bug reports and distro compatibility reports
|
|
- Pull request template
|