docs: cross-platform install instructions in README #2

Merged

owlburtoe merged 1 commit from docs/install-instructions into main

2026-07-14 14:31:29 -04:00

owlburtoe commented

2026-07-14 14:30:29 -04:00

Owner

What

Adds an Install section to the README covering Windows, macOS, and Linux, written for someone with no dev tools installed.

Split by what the reader actually has:

Part 1 — you have an installer file. Per-OS click-through, including the parts people get stuck on: Windows SmartScreen ("More info → Run anyway"), the macOS right-click → Open trick, the xattr -dr com.apple.quarantine fix for "app is damaged", and chmod +x / apt install ./file.deb on Linux.
Part 2 — source only, no toolchain. CLI-first prerequisites (winget on Windows, brew + xcode-select on macOS, apt/dnf/pacman + nvm on Linux), with manual download links kept as a collapsed fallback. Then a verify step, the three build commands, and a table of where the installer lands.

The old Develop / build section is trimmed to just the dev loop and points at Part 2 for prereqs. The end-user walkthrough (now Using it) links to Install rather than repeating it.

Notes

Linux dependency lists (libwebkit2gtk-4.1-dev etc.), the Rustlang.Rustup winget ID, and rustup default stable-msvc come from Tauri's current v2 prerequisites docs.
The VS Build Tools --override "--add Microsoft.VisualStudio.Workload.VCTools --includeRecommended" flags are not from the Tauri docs (they only document the GUI installer) — standard MS workload flags, worth confirming on the Windows box at next build.
Linux is labelled unsupported-but-working: bundle.targets is "all" and there's no platform-specific code, so it builds, but nobody runs it there.
Also notes that an Apple Silicon .dmg won't run on an Intel Mac.

Test plan

Rendered README reads correctly on Forgejo (anchors, <details> blocks, table).
Windows: winget block installs a working toolchain and npm run tauri build produces the NSIS installer.

Docs only — no code, no tests affected.

## What Adds an **Install** section to the README covering Windows, macOS, and Linux, written for someone with no dev tools installed. Split by what the reader actually has: - **Part 1 — you have an installer file.** Per-OS click-through, including the parts people get stuck on: Windows SmartScreen ("More info → Run anyway"), the macOS right-click → Open trick, the `xattr -dr com.apple.quarantine` fix for "app is damaged", and `chmod +x` / `apt install ./file.deb` on Linux. - **Part 2 — source only, no toolchain.** CLI-first prerequisites (`winget` on Windows, `brew` + `xcode-select` on macOS, `apt`/`dnf`/`pacman` + `nvm` on Linux), with manual download links kept as a collapsed fallback. Then a verify step, the three build commands, and a table of where the installer lands. The old `Develop / build` section is trimmed to just the dev loop and points at Part 2 for prereqs. The end-user walkthrough (now `Using it`) links to Install rather than repeating it. ## Notes - Linux dependency lists (`libwebkit2gtk-4.1-dev` etc.), the `Rustlang.Rustup` winget ID, and `rustup default stable-msvc` come from Tauri's current v2 prerequisites docs. - The VS Build Tools `--override "--add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"` flags are **not** from the Tauri docs (they only document the GUI installer) — standard MS workload flags, worth confirming on the Windows box at next build. - Linux is labelled **unsupported-but-working**: `bundle.targets` is `"all"` and there's no platform-specific code, so it builds, but nobody runs it there. - Also notes that an Apple Silicon `.dmg` won't run on an Intel Mac. ## Test plan - [ ] Rendered README reads correctly on Forgejo (anchors, `<details>` blocks, table). - [ ] Windows: `winget` block installs a working toolchain and `npm run tauri build` produces the NSIS installer. Docs only — no code, no tests affected.

owlburtoe added 1 commit

2026-07-14 14:30:29 -04:00

docs: cross-platform install instructions in README db30e01d3c

Add an Install section covering Windows, macOS, and Linux for users who
have an installer file and for users who must build from source with no
toolchain present. CLI-first (winget / brew / apt+nvm) with manual
download links as fallback.

owlburtoe merged commit afc3959dba into main

2026-07-14 14:31:29 -04:00

owlburtoe deleted branch docs/install-instructions

2026-07-14 14:31:29 -04:00

owlburtoe referenced this pull request from a commit

2026-07-14 14:31:31 -04:00

Merge pull request 'docs: cross-platform install instructions in README' (#2) from docs/install-instructions into main

owlburtoe referenced this pull request

2026-07-14 17:49:37 -04:00

docs: add terminal + git clone steps to build instructions #3