docs(readme): current usage, GPU and CUDA section, single upstream credit #56

2026-11-07T02:58:15Z

xavierk commented

2026-11-07 02:58:15 +00:00

Quick start: install, upgrade with xbps, first run, push-to-talk, toggle, niri, debug.
New GPU and CUDA section: the published package accelerates with Vulkan and CPU; CUDA is only a local-build or user-environment option.
The old project name now appears once, in the Origin credit line (inspired by).
tests/test_rename_sweep.py records the new credit line.

- Quick start: install, upgrade with xbps, first run, push-to-talk, toggle, niri, debug. - New GPU and CUDA section: the published package accelerates with Vulkan and CPU; CUDA is only a local-build or user-environment option. - The old project name now appears once, in the Origin credit line (inspired by). - tests/test_rename_sweep.py records the new credit line.

xavierk added 1 commit 2026-11-07 02:58:15 +00:00

docs(readme): current usage instructions, GPU and CUDA explanation, single upstream credit

CI / security (pull_request) Successful in 1m19s

Details

CI / lint (pull_request) Successful in 23s

Details

CI / ai-review (pull_request) Successful in 18s

Details

f9792219e3

Quick start with upgrade, first run, dictation, niri and debug steps. New GPU and CUDA section stating that the published package uses Vulkan and CPU and that CUDA is a local-build option. The old name now appears only in the Origin credit line.

bongbetic-pr-bot commented

2026-11-07 03:00:18 +00:00

First-time contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review

Broken anchor link

The intro line links to [Origin](#origin), but the section heading was renamed to ## Origin — GitHub anchors for ## Origin are #origin, so this actually resolves correctly. However, the features bullet links to [GPU and CUDA](#gpu-and-cuda) while the new section heading is ## GPU and CUDA, which produces anchor #gpu-and-cuda — this also matches. No issue after verification; disregard if anchor generation differs. (No concrete broken link found.)

No account is required. Models download once. After that, speech-to-text stays on your machine. It is built for Void Linux, with niri and the Dank Material Shell in mind, and is inspired by an earlier project credited under [Origin](#origin).

Removed concrete examples

The migration section previously listed the exact leftover launcher paths (~/.local/share/applications/vocalinux.desktop, ~/.local/bin/vocalinux, ~/.local/bin/vocalinux-gui) with copy-pasteable rm commands. The rewritten "Leftover launchers from an earlier install" section only says to "remove the ones it names yourself," so a user whose notice doesn't fire (or who reads the README before launching) no longer has the concrete paths to act on. Consider keeping the example paths alongside the new wording.

### Leftover launchers from an earlier install

Launchers left by an earlier install of the upstream project can point at a Python
environment that no longer exists. They start nothing, yet they appear next to
Voculinux in the application menu. Voculinux logs and shows one notice that names
those files. It never deletes or changes them, so remove the ones it names
yourself. Keep any launcher that still starts a working install.

## PR Reviewer Guide 🔍  Here are some key observations to aid the review process: <table> <tr><td>⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪</td></tr> <tr><td>🧪 PR contains tests</td></tr> <tr><td>🔒 No security concerns identified</td></tr> <tr><td>⚡ Recommended focus areas for review <details><summary><a href='https://git.bongbetic.com/xavierk/voculinux/src/branch/docs/readme-usage/README.md#L22-L22'>Broken anchor link</a> The intro line links to `[Origin](#origin)`, but the section heading was renamed to `## Origin` — GitHub anchors for `## Origin` are `#origin`, so this actually resolves correctly. However, the features bullet links to `[GPU and CUDA](#gpu-and-cuda)` while the new section heading is `## GPU and CUDA`, which produces anchor `#gpu-and-cuda` — this also matches. No issue after verification; disregard if anchor generation differs. (No concrete broken link found.) </summary> ```markdown No account is required. Models download once. After that, speech-to-text stays on your machine. It is built for Void Linux, with niri and the Dank Material Shell in mind, and is inspired by an earlier project credited under [Origin](#origin). ``` </details> <details><summary><a href='https://git.bongbetic.com/xavierk/voculinux/src/branch/docs/readme-usage/README.md#L193-L199'>Removed concrete examples</a> The migration section previously listed the exact leftover launcher paths (`~/.local/share/applications/vocalinux.desktop`, `~/.local/bin/vocalinux`, `~/.local/bin/vocalinux-gui`) with copy-pasteable `rm` commands. The rewritten "Leftover launchers from an earlier install" section only says to "remove the ones it names yourself," so a user whose notice doesn't fire (or who reads the README before launching) no longer has the concrete paths to act on. Consider keeping the example paths alongside the new wording. </summary> ```markdown ### Leftover launchers from an earlier install Launchers left by an earlier install of the upstream project can point at a Python environment that no longer exists. They start nothing, yet they appear next to Voculinux in the application menu. Voculinux logs and shows one notice that names those files. It never deletes or changes them, so remove the ones it names yourself. Keep any launcher that still starts a working install. ``` </details> </td></tr> </table>

xavierk merged commit 808bd17704 into main

2026-11-07 03:00:25 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: xavierk/voculinux#56