xavierk
34d33d73bd
The app template fetched upstream's 0.18.5 archive, carried upstream's homepage and maintainer, and renamed the launchers and desktop entry in post_install. The fork's sdist already names them voculinux, so the template now sources the fork's release asset and installs the names as they are. The checksum is an explicit pending marker until the fork's v0.18.5 release exists, which fails closed in xbps-src and never falls back to the upstream digest. depends now pulls in pipewire (capture), wtype (direct typing on niri), wl-clipboard (clipboard), xdotool (X11 and XWayland) and pulseaudio-utils (pactl), and drops ibus, which cannot inject on niri. Every name is checked against the Void index. INSTALL.msg states the niri first run plainly (no permission prompt; typing goes direct), never points at the portal on niri, and drops the IBus claim. The container smoke queries the fork's distribution name. Tests assert the fork sources, the pending-or-pinned checksum, the runtime helpers, the absence of ibus, and the niri wording.
Documentation
User and maintainer documentation for Voculinux.
| Document | Audience | Description |
|---|---|---|
| INSTALL.md | Users | Recommended install, AppImage, AUR, Flatpak, Snap, CLI |
| INSTALL_MANUAL.md | Users | Manual install, system packages, PyPI/pipx |
| TROUBLESHOOTING.md | Users | Common install and runtime failures |
| USER_GUIDE.md | Users | Dictation, engines, models, shortcuts, tips |
| NIRI.md | Users | niri keybind pack and Dank Material Shell notes |
| UPDATE.md | Users | How to upgrade; release notes by version |
| DISTRO_COMPATIBILITY.md | Users | Distro matrix, session caveats |
| HTTP_REMOTE.md | Power users | Remote HTTP transcription |
| FLATPAK_REMOTE.md | Users / maintainers | Self-hosted Flatpak remote and publishing |
| GATEWAY_EMBED.md | Users | Optional local VocaGateway integration |
| CUSTOM_DICTIONARY_DESIGN.md | Contributors | Custom terms and correction design |
| ARCHITECTURE.md | Contributors | Application modules, data flow, and threads |
| Performance benchmarks | Contributors | Before and after charts for the performance pass |
| AUR.md | Arch users / maintainers | AUR packages and publish secrets |
| RELEASE_PROCESS.md | Maintainers | Version bump, checklist, tagging |
Project root:
| Document | Description |
|---|---|
| README.md | Project overview and quick start |
| CHANGELOG.md | Release history pointers |
| SUPPORT.md | Where to get help |
| CONTRIBUTING.md | Development setup and pull requests |
| SECURITY.md | Vulnerability reporting and supported versions |
| CODE_OF_CONDUCT.md | Community standards |
Website product and design notes live under web/ (PRODUCT.md, DESIGN.md, README.md). Flatpak packaging: packaging/flatpak/README.md.
Website: voculinux.com