docs(readme): add install-format badges and a Nix flake section (#949)
Represent every distribution format in the README header shields: AppImage, .deb, .rpm, Flatpak, Snap (edge), AUR, PyPI, and Nix flake, grouped on their own row above the social badges. Also documents the flake install path in the Install section. Co-authored-by: Jatin K Malik <jatinkrmalik@gmail.com>
This commit is contained in:
co-authored by
Jatin K Malik
parent
0faac6b3b8
commit
d89248ae0b
@@ -18,12 +18,19 @@
|
||||
[](https://www.python.org/downloads/)
|
||||
[](CONTRIBUTING.md)
|
||||
|
||||
[](https://github.com/VocaHQ/vocalinux/releases)
|
||||
[](https://github.com/VocaHQ/vocalinux/releases/latest)
|
||||
[](https://github.com/VocaHQ/vocalinux/releases/latest)
|
||||
[](https://github.com/VocaHQ/vocalinux/releases/latest)
|
||||
[](#flatpak-any-distro)
|
||||
[](https://snapcraft.io/vocalinux)
|
||||
[](https://aur.archlinux.org/packages/vocalinux)
|
||||
[](https://pypi.org/project/vocalinux/)
|
||||
[](packaging/nix/README.md)
|
||||
|
||||
[](https://discord.gg/t6muquAJbm)
|
||||
[](https://vocahq.com)
|
||||
[](https://x.com/vocahq)
|
||||
[](https://github.com/VocaHQ/vocalinux/releases)
|
||||
[](https://pypi.org/project/vocalinux/)
|
||||
[](https://aur.archlinux.org/packages/vocalinux)
|
||||
|
||||
[Website](https://vocalinux.com) · [Install](#install) · [Docs](#documentation) · [Releases](https://github.com/VocaHQ/vocalinux/releases)
|
||||
|
||||
@@ -44,7 +51,7 @@ No Voca account is required. Models download once. After that, speech-to-text st
|
||||
- **Toggle or push-to-talk**: New installs default to hold Right Alt; existing configs keep their shortcut
|
||||
- **System tray + settings**: Searchable sidebar, Speech Model simple setup with Advanced as an island, status icons, audio feedback
|
||||
- **Start on login**: XDG autostart (desktop session, not a systemd service)
|
||||
- **Packaging**: install script, `.deb` / `.rpm`, AppImage, AUR, PyPI, Snap (`--edge`), Flatpak (release bundles and local build; not on Flathub)
|
||||
- **Packaging**: install script, `.deb` / `.rpm`, AppImage, AUR, PyPI, Snap (`--edge`), Flatpak (release bundles and local build; not on Flathub), Nix flake
|
||||
|
||||
## Screenshots
|
||||
|
||||
@@ -222,6 +229,15 @@ sudo snap install --dangerous ./vocalinux_0.18.2_amd64.snap
|
||||
sudo snap connect vocalinux:uinput
|
||||
```
|
||||
|
||||
### Nix / NixOS (flake)
|
||||
|
||||
```bash
|
||||
nix run github:VocaHQ/vocalinux # try it
|
||||
nix profile install github:VocaHQ/vocalinux
|
||||
```
|
||||
|
||||
The flake also ships `nixosModules.vocalinux` and `homeManagerModules.vocalinux` for declarative installs (`programs.vocalinux.enable = true`). The bundled pywhispercpp builds with Vulkan GPU inference. Details: [packaging/nix/README.md](packaging/nix/README.md).
|
||||
|
||||
### From source
|
||||
|
||||
```bash
|
||||
@@ -318,7 +334,7 @@ Neural VAD (Silero) is used when `onnxruntime` is available; install via `pip in
|
||||
|
||||
| Document | Description |
|
||||
|----------|-------------|
|
||||
| [Installation](docs/INSTALL.md) | Installer, AppImage, AUR, Flatpak, Snap, running |
|
||||
| [Installation](docs/INSTALL.md) | Installer, AppImage, AUR, Flatpak, Snap, Nix flake, running |
|
||||
| [Manual / PyPI install](docs/INSTALL_MANUAL.md) | Package lists and pip workflows |
|
||||
| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common failures |
|
||||
| [User guide](docs/USER_GUIDE.md) | Dictation, engines, models, tips |
|
||||
|
||||
Reference in New Issue
Block a user