Files
voculinux/docs
c3c390f19d feat(nix): add flake package, NixOS and Home Manager modules (#936)
* feat(nix): add flake package, NixOS and Home Manager modules

Add a flake.nix plus packaging/nix derivations so Nix and NixOS users can
run and install Vocalinux declaratively, including via Home Manager.

- package.nix: buildPythonApplication with GTK3, libayatana-appindicator,
  IBus and libnotify typelibs; wraps the entry point with every host tool
  the injectors probe for (xdotool, wtype, ydotool, wl-clipboard, xclip,
  xsel, xprop, setxkbmap, ibus, gdbus, notify-send, paplay, aplay)
- pywhispercpp.nix: builds pywhispercpp from its vendored PyPI sdist
  (absent from nixpkgs, same gap as Debian/Fedora), static whisper.cpp,
  GGML_NATIVE=OFF for a portable baseline
- module.nix: NixOS module enabling hardware.uinput and installing the
  package; input/uinput group membership stays a per-user choice
- home-manager.nix: programs.vocalinux.enable installs into the profile
- docs/INSTALL.md gains a Nix / NixOS section; packaging/nix/README.md
  carries the usage snippets

Refs #931

* fix(nix): address review findings on imports check and docs

- pywhispercpp: check pywhispercpp.model and _pywhispercpp too, so the
  compiled binding is proven loadable, not just the package
- README Home Manager example: declare the nixpkgs/home-manager inputs
  and pass pkgs, which homeManagerConfiguration requires
- package.nix: use top-level xprop/setxkbmap attrs (xorg.* is deprecated)

---------

Co-authored-by: Jatin K Malik <jatinkrmalik@gmail.com>
2026-10-10 20:40:25 -07:00
..

Documentation

User and maintainer documentation for Vocalinux.

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
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
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: vocalinux.com