+ Fork status: the fork Flatpak remote below is not published yet — + these commands resolve once the first fork release lands. The install + script installs upstream Vocalinux today. +
- Fork status: this command fetches the upstream install script, so - it installs Vocalinux (upstream), not Voculinux. Fork release - artefacts are not published yet. + Fork status: this command fetches the upstream install script, so it + installs Vocalinux (upstream), not Voculinux. Fork release artefacts + are not published yet.
diff --git a/web/src/app/install/nixos/page.tsx b/web/src/app/install/nixos/page.tsx index d61b721..640fbc9 100644 --- a/web/src/app/install/nixos/page.tsx +++ b/web/src/app/install/nixos/page.tsx @@ -217,12 +217,12 @@ export default function NixosInstallPage() {Voculinux does not yet publish its own Nix flake. The flake below is - the upstream Vocalinux flake: it builds the app against nixpkgs, - ships a NixOS module and a Home Manager module, and wires every + the upstream Vocalinux flake: it builds the app against nixpkgs, ships + a NixOS module and a Home Manager module, and wires every text-injection and clipboard tool onto the wrapped binary’s PATH. Its snippets install Vocalinux (upstream), not Voculinux. For - Voculinux on Void Linux, use the signed xbps repository or the - install script. + Voculinux on Void Linux, use the install script today; a signed xbps + repository will ship with fork releases once published.
diff --git a/web/src/app/install/page.tsx b/web/src/app/install/page.tsx index f6c33e1..6795d71 100644 --- a/web/src/app/install/page.tsx +++ b/web/src/app/install/page.tsx @@ -37,7 +37,8 @@ const distroGuides = [ { name: "Debian", href: "/install/debian/", - description: "Debian 12+ with the install script or the native .deb package.", + description: + "Debian 12+ with the install script or the native .deb package.", icon: Terminal, }, { @@ -49,7 +50,8 @@ const distroGuides = [ { name: "Linux Mint", href: "/install/linux-mint/", - description: "Voice dictation on Linux Mint releases built on Ubuntu 24.04.", + description: + "Voice dictation on Linux Mint releases built on Ubuntu 24.04.", icon: Laptop, }, { @@ -88,7 +90,8 @@ export default function InstallGuidesPage() {Pick your distro guide and follow a proven setup flow for offline - speech-to-text on Linux. Every guide is written for real desktop usage. + speech-to-text on Linux. Every guide is written for real desktop + usage.
- Then launch voculinux.
+ Then launch vocalinux — the upstream binary the script
+ installs today. Fork releases will ship voculinux.
- Fork status: this command fetches the upstream install script, so - it installs Vocalinux (upstream), not Voculinux. Fork release - artefacts are not published yet. + Fork status: this command fetches the upstream install script, so it + installs Vocalinux (upstream), not Voculinux. Fork release artefacts + are not published yet.
- x86_64 or aarch64 from GitHub Releases. No root. Host + x86_64 or aarch64 from upstream GitHub Releases. No root. Host text-injection tools are still required.
@@ -127,18 +131,15 @@ export default function InstallGuidesPage() {New
- .deb for Debian 12+ and Ubuntu 24.04+. .rpm for Fedora. - x86_64 and aarch64 on every release. + .deb for Debian 12+ and Ubuntu 24.04+. .rpm for Fedora. x86_64 and + aarch64 on every fork release once published.
- +Auto-updates
- Install once from the Flatpak remote and{" "}
+ Install once from the fork Flatpak remote once published and{" "}
flatpak update carries each stable release. Or
sideload the .flatpak bundle.
Snap Store
- snap install voculinux --edge. amd64 only for
- now; a .snap is attached to every release too.
+ snap install voculinux --edge, once the fork Snap is
+ published (not published yet). amd64 only; a .snap will be
+ attached to fork releases too.
- yay -S voculinux, or voculinux-bin for the
- prebuilt package.
+ yay -S voculinux, or voculinux-bin for the prebuilt
+ package. Fork packages are not published yet.
- Clone the repo and run ./install.sh. The install
- guide has the full source path.
+ Clone the repo and run ./install.sh. The upstream
+ install guide has the full source path.
+ Fork status: packaged artefacts (AppImage, .deb/.rpm, Flatpak, Snap, + AUR) are not published yet — the cards above link upstream artefacts + or reserved fork names until the first fork release lands. +
+ vocalinux
+ {" "}
+ (the upstream binary; fork releases will use{" "}
voculinux
- .
+ ).
- Hold Right Alt. Text lands in the focused window. Local engines - by default. + Hold Right Alt. Text lands in the focused window. Local engines by + default.
model / path
- On-device mode is the default: download a speech-to-text - model and process here. If you want shared compute, point - Remote API at a server you run. + On-device mode is the default: download a speech-to-text model + and process here. If you want shared compute, point Remote API + at a server you run.
- The application is open source under AGPL-3.0. Settings, engines, - and the injection path are in the repository. + The application is open source under AGPL-3.0. Settings, + engines, and the injection path are in the repository.
The interactive installer detects hardware, lets you pick an engine, and wires the desktop app. Ubuntu, Fedora, Debian, Arch, - and openSUSE. Native .deb, .rpm, Snap, and Flatpak packages - ship with every release. + and openSUSE. Native .deb, .rpm, Snap, and Flatpak packages are + planned for every fork release.
Then launch voculinux.
+ Then launch vocalinux — the upstream binary the script
+ installs today. Fork releases will ship voculinux.
+
- Fork status: this command fetches the upstream install script, so - it installs Vocalinux (upstream), not Voculinux. Fork release - artefacts are not published yet. + Fork status: this command fetches the upstream install script, so it + installs Vocalinux (upstream), not Voculinux. Fork release artefacts + are not published yet.
Signed xbps repository data will ship with releases once the - packaging pipeline lands. Until then, use the install script - or build from source. + packaging pipeline lands. Until then, use the install script or + build from source.
No installer- x86_64 or aarch64 from GitHub Releases. No root. Host + x86_64 or aarch64 from upstream GitHub Releases. No root. Host text-injection tools are still required.
@@ -790,8 +790,8 @@ export default function HomePage() {New
- .deb for Debian 12+ and Ubuntu 24.04+. .rpm for Fedora. - x86_64 and aarch64 on every release. + .deb for Debian 12+ and Ubuntu 24.04+. .rpm for Fedora. x86_64 + and aarch64 on every fork release once published.
Auto-updates
- Install once from the Flatpak remote and{" "}
+ Install once from the fork Flatpak remote once published and{" "}
flatpak update carries each stable release. Or
sideload the .flatpak bundle.
Snap Store
- snap install voculinux --edge. amd64 only for
- now; a .snap is attached to every release too.
+ snap install voculinux --edge, once the fork Snap
+ is published (not published yet). amd64 only; a .snap will be
+ attached to fork releases too.
- yay -S voculinux, or voculinux-bin for the
- prebuilt package.
+ yay -S voculinux, or voculinux-bin for the prebuilt
+ package. Fork packages are not published yet.
- Clone the repo and run ./install.sh. The install
- guide has the full source path.
+ Clone the repo and run ./install.sh. The upstream
+ install guide has the full source path.
+ Fork status: packaged artefacts (AppImage, .deb/.rpm, Flatpak, Snap, + AUR, xbps) are not published yet — the cards above link upstream + artefacts or reserved fork names until the first fork release lands. +
Ubuntu guide {" · "} @@ -854,7 +860,10 @@ export default function HomePage() { All distro notes
--engine whisper_cpp, whisper,{" "}
- vosk, or remote_api.{" "}
+ Settings dialog or CLI: --engine whisper_cpp,{" "}
+ whisper, vosk, or{" "}
+ remote_api.{" "}
Compare engines.
),
@@ -981,9 +989,9 @@ export default function HomePage() {
Voculinux is a hard fork of Vocalinux for Void Linux (glibc, - Wayland-primary under niri). The internal Python module keeps - the upstream name so fixes stay cheap to port by hand; upstream - links below are retained as provenance. + Wayland-primary under niri). The internal Python module keeps the + upstream name so fixes stay cheap to port by hand; upstream links + below are retained as provenance.
- The upstream Linux dictation app this fork is ported from. - Fixes are taken by hand, one at a time. + The upstream Linux dictation app this fork is ported from. Fixes + are taken by hand, one at a time.
Free and open source under AGPL-3.0. Local engines by default.
@@ -1078,7 +1088,8 @@ export default function HomePage() {- Then hold Right Alt and speak into the app already in front of you. + Then hold Right Alt and speak into the app already in front of + you.
diff --git a/web/src/lib/__tests__/voculinux-rebrand.test.ts b/web/src/lib/__tests__/voculinux-rebrand.test.ts index 88f3d26..367de90 100644 --- a/web/src/lib/__tests__/voculinux-rebrand.test.ts +++ b/web/src/lib/__tests__/voculinux-rebrand.test.ts @@ -1,5 +1,10 @@ +import fs from "fs"; +import path from "path"; import { SITE_NAME, SITE_URL } from "../seo"; +const readPage = (...segments: string[]): string => + fs.readFileSync(path.join(process.cwd(), "src", "app", ...segments), "utf-8"); + describe("voculinux rebrand (ticket #24)", () => { it("names the fork site", () => { expect(SITE_NAME).toBe("Voculinux"); @@ -9,3 +14,63 @@ describe("voculinux rebrand (ticket #24)", () => { expect(SITE_URL).toBe("https://voculinux.com"); }); }); + +describe("fork install honesty (ticket #24, AC1)", () => { + const home = readPage("page.tsx"); + const install = readPage("install", "page.tsx"); + const distro = readPage("install", "[distro]", "page.tsx"); + const nixos = readPage("install", "nixos", "page.tsx"); + const flatpak = readPage("flatpak", "page.tsx"); + + it("does not promise packaged artefacts with every release", () => { + for (const [name, source] of [ + ["home", home], + ["install", install], + ] as const) { + expect(`${name}: ${source}`).not.toContain("ship with every release"); + } + }); + + it("does not tell users to launch the fork binary after the upstream script", () => { + for (const [name, source] of [ + ["home", home], + ["install", install], + ] as const) { + expect(`${name}: ${source}`).not.toContain( + "Then launchvoculinux",
+ );
+ }
+ });
+
+ it("discloses fork status on every packaged-artefact surface", () => {
+ for (const [name, source] of [
+ ["home", home],
+ ["install", install],
+ ["distro", distro],
+ ["flatpak", flatpak],
+ ] as const) {
+ expect(`${name} discloses fork status: ${source}`).toContain(
+ "Fork status:",
+ );
+ expect(`${name} states artefacts are unpublished: ${source}`).toMatch(
+ /not published yet|not yet published|once published/,
+ );
+ }
+ });
+
+ it("does not present the signed xbps repository as available today", () => {
+ expect(`nixos: ${nixos}`).not.toContain("use the signed xbps repository");
+ });
+
+ it("labels upstream release links as upstream until fork releases land", () => {
+ for (const [name, source] of [
+ ["home", home],
+ ["install", install],
+ ["distro", distro],
+ ] as const) {
+ expect(`${name} marks upstream artefacts: ${source}`).toMatch(
+ /upstream GitHub Releases|upstream artefacts|upstream install script/,
+ );
+ }
+ });
+});