summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2026-07-24 12:46:45 +0200
committerYuval Adam <_@yuv.al>2026-07-24 12:46:45 +0200
commitc6a83f2392293bd34c0c9ba6286bf34063446027 (patch)
tree8d4845328fa99a505bd83fe1d62be0ea6278861e /README.md
parenta0e54437fe03b36903faa8b600b6ba903cb15392 (diff)
Add IBus passthrough insertion prototype
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1e091cb..a603464 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,8 @@ By default it finds `transcribe-cli` on `PATH` and the model at `$XDG_DATA_HOME/
- `PARLEY_TRANSCRIPT_DIR`
- `PARLEY_DEVICE`
- `PARLEY_LANGUAGE`
+- `PARLEY_AUTO_INSERT`
+- `PARLEY_INSERTION_MODE` (`clipboard` or `ibus`)
Run tests without desktop, microphone, or model dependencies:
@@ -103,6 +105,22 @@ gnome-extensions info parley@org.parley
The top-bar microphone shows daemon state and its menu provides start/stop, cancel, copy-last, and open-folder actions. Source changes are visible through the symlink, but GNOME Shell must reload the extension; toggle it off and on with the Extensions app. A newly installed extension may require one logout/login on Wayland before Shell discovers it.
+### IBus insertion experiment
+
+The development installer also starts a minimal persistent passthrough IBus engine. Enable the experiment with:
+
+```bash
+./scripts/enable-ibus-test
+```
+
+This saves the current engine, selects Parley, and enables automatic IBus insertion in the daemon. Put the caret in a normal text field and use the recording shortcut twice. Successful transcripts are still saved and copied before insertion. Password and PIN purposes are refused where the application reports them.
+
+This is a bake-off prototype: while it is enabled, explicitly test normal typing, modifiers, shortcuts, compose/dead keys, layout switching, terminals, browsers, and Electron applications. Restore the previous engine and clipboard-only mode with:
+
+```bash
+./scripts/disable-ibus-test
+```
+
## Arch Linux package
The local PKGBUILD installs `parleyd` and the other executables under `/usr/bin`, the systemd **user** unit under `/usr/lib/systemd/user`, and the session D-Bus service under `/usr/share/dbus-1/services`. It builds from the latest committed state of this checkout: