diff options
| author | Yuval Adam <_@yuv.al> | 2026-07-24 13:32:36 +0200 |
|---|---|---|
| committer | Yuval Adam <_@yuv.al> | 2026-07-24 13:32:36 +0200 |
| commit | e2656ebe8f36dcd213c2412d80f913172664e8d1 (patch) | |
| tree | c5bab51bb170e0369c2217838a8dc9b1678797c7 /README.md | |
| parent | 58b465b5b84cb90424eeffd6f877c8e5ad7bd647 (diff) | |
Prepare Parley 1.0.0 release
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 25 insertions, 4 deletions
@@ -37,6 +37,25 @@ parleyctl insert If an application rejects IBus insertion, the transcript remains saved and ready to paste with `Ctrl+V`. +## Installation + +Build and install the Arch package from a release checkout: + +```bash +cd packaging/arch +makepkg -si +systemctl --user enable --now parley.service +gnome-extensions enable parley@org.parley +``` + +Configure a GNOME custom shortcut to run: + +```text +/usr/bin/parleyctl toggle +``` + +A newly installed Shell extension may require one logout and login before GNOME discovers it. + ## Runtime Parley requires the Parakeet `transcribe-cli` runtime and Unified English model. By default it looks for the runtime on `PATH` and the model under: @@ -47,11 +66,11 @@ Parley requires the Parakeet `transcribe-cli` runtime and Unified English model. The model is not stored in this repository. The current runtime build also depends on host CUDA and MKL libraries. Optional settings live in [`~/.config/parley/config.toml`](docs/CONFIGURATION.md); Parley does not use application-specific environment variables. -## Status +## Compatibility -The development build provides the daemon, CLI, systemd user service, GNOME Shell extension, clipboard fallback, and persistent passthrough IBus engine. End-to-end insertion is confirmed in Firefox and Ghostty; broader application and input-method testing is ongoing. +End-to-end insertion is confirmed in Firefox, Chrome, Visual Studio Code, LibreOffice, and Ghostty. Broader application and input-method results live in the [IBus test matrix](docs/IBUS_BAKEOFF.md). -See the [IBus test matrix](docs/IBUS_BAKEOFF.md) and [project specification](SPEC.md) for details. +See the [changelog](CHANGELOG.md) and [project specification](SPEC.md) for release details and architecture. ## Development @@ -81,4 +100,6 @@ Development helpers live in [`scripts/`](scripts/), and the Arch package recipe ## License -Parley is licensed under GPL-3.0-or-later. +Parley is licensed under GPL-3.0-or-later. Copyright © 2026 Yuval Adam. + +Questions and release reports: [hello@yuv.al](mailto:hello@yuv.al). |