Skip to content

docs(install): surface winget availability across README + docs #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
packetThrower merged 1 commit into from
May 27, 2026
Merged

docs(install): surface winget availability across README + docs #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[![CI](https://img.shields.io/github/actions/workflow/status/packetThrower/Baudrun/ci.yml?branch=main&style=flat-square&logo=github&label=CI)](https://github.com/packetThrower/Baudrun/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/packetThrower/Baudrun?style=flat-square&logo=github&label=release&include_prereleases)](https://github.com/packetThrower/Baudrun/releases/latest)
[![Downloads](https://img.shields.io/github/downloads/packetThrower/Baudrun/total?style=flat-square&logo=github&label=downloads)](https://github.com/packetThrower/Baudrun/releases)
[![winget](https://img.shields.io/badge/winget-packetThrower.Baudrun-0078D4?style=flat-square&logo=windows&logoColor=white)](https://github.com/microsoft/winget-pkgs/tree/master/manifests/p/packetThrower/Baudrun)
[![Rust](https://img.shields.io/badge/Rust-stable-CE422B?style=flat-square&logo=rust&logoColor=white)](Cargo.toml)
[![License: GPL v3+](https://img.shields.io/badge/license-GPLv3%2B-blue?style=flat-square)](LICENSE)

Expand Down Expand Up @@ -104,25 +105,33 @@ Sample JSON for authoring your own skins, themes, and highlight packs is on the
## Install

On macOS and Windows, the package managers track the latest stable tag and get
you past the first-launch Gatekeeper and SmartScreen warnings. Both also have a
pre-release channel that installs alongside stable.
you past the first-launch Gatekeeper and SmartScreen warnings. Homebrew, Scoop,
and winget also bypass the SmartScreen prompt; winget is Microsoft's own and
ships built-in on Windows 10 1809+ and Windows 11.

```sh
# macOS — Homebrew
brew tap packetThrower/tap
brew install --cask baudrun # stable
brew install --cask baudrun@alpha # pre-release

# Windows — winget (Microsoft's package manager, preinstalled)
winget install packetThrower.Baudrun # or: winget install baudrun

# Windows — Scoop
scoop install git # if you don't already have git
scoop bucket add packetThrower https://github.com/packetThrower/scoop-bucket
scoop install baudrun # stable
scoop install baudrun-prerelease # pre-release
```

The taps also hold related tools. Repos:
The Homebrew and Scoop taps also hold related tools, and Scoop has a separate
manifest for the pre-release channel. winget only carries stable; for
pre-release builds on Windows, use Scoop or download from
[Releases](https://github.com/packetThrower/Baudrun/releases) directly. Repos:
[packetThrower/homebrew-tap](https://github.com/packetThrower/homebrew-tap),
[packetThrower/scoop-bucket](https://github.com/packetThrower/scoop-bucket).
[packetThrower/scoop-bucket](https://github.com/packetThrower/scoop-bucket),
[microsoft/winget-pkgs `packetThrower/Baudrun`](https://github.com/microsoft/winget-pkgs/tree/master/manifests/p/packetThrower/Baudrun).

Linux users grab the matching `.deb` / `.rpm` / `.AppImage` /
`.pkg.tar.zst` directly from the
Expand Down
43 changes: 38 additions & 5 deletions docs-next/src/content/docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,35 @@ Update with `brew upgrade --cask baudrun` (or `baudrun@alpha`). The tap's
auto-bump workflow polls upstream every 6 hours, so a new tag is normally
installable within a quarter day.

## Windows (winget)

[winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/)
is Microsoft's own package manager, preinstalled on Windows 10 1809+ and
Windows 11. The [packetThrower.Baudrun manifest](https://github.com/microsoft/winget-pkgs/tree/master/manifests/p/packetThrower/Baudrun)
ships per-arch MSI installers and resolves either by the full
`PackageIdentifier` or the short moniker:

```powershell
winget install packetThrower.Baudrun # full identifier
winget install baudrun # short moniker (same result)
```

winget picks the right architecture automatically (x64 or arm64) based on
the host. The MSI installs to `Program Files\Baudrun\`, registers under
Apps & Features with the Baudrun icon, and adds a Start menu shortcut.
Silent install is the default for winget (no SmartScreen prompt, no
clicks).

winget carries **stable only** — no pre-release channel. If you want to
ride pre-release builds on Windows, use Scoop below (which has a
`baudrun-prerelease` manifest) or grab the artifact directly from the
[Releases](https://github.com/packetThrower/Baudrun/releases) page.

Update with `winget upgrade packetThrower.Baudrun` (or
`winget upgrade --all`). winget polls Microsoft's centralized manifest
index every few hours, so a new stable tag is normally installable
within a quarter day of release.

## Windows (Scoop)

The bucket [`packetThrower/scoop-bucket`](https://github.com/packetThrower/scoop-bucket)
Expand Down Expand Up @@ -165,19 +194,21 @@ are on the near-term roadmap before that becomes an auto-install path.

Pre-release tags (`vX.Y.Z-alpha.N`, `-beta.N`, `-rc.N`) trigger the same
release workflow as stable but publish under GitHub's "Pre-release" badge
and don't displace the "Latest release" pointer. Both Homebrew and Scoop
expose a separate manifest for that channel. Installs land side-by-side
with stable so both can run on the same machine:
and don't displace the "Latest release" pointer. Homebrew and Scoop both
expose a separate manifest for that channel; winget is stable-only.
Installs land side-by-side with stable so both can run on the same
machine:

| Channel | macOS install | Windows install |
|---|---|---|
| Stable | `brew install --cask baudrun` | `scoop install baudrun` |
| Stable | `brew install --cask baudrun` | `winget install packetThrower.Baudrun` or `scoop install baudrun` |
| Pre-release | `brew install --cask baudrun@alpha` | `scoop install baudrun-prerelease` |

Linux users grab a pre-release tag's artifact directly from the
[Releases](https://github.com/packetThrower/Baudrun/releases) page. The
"latest/download/" shortcut always tracks stable so it isn't useful for
pre-release downloads.
pre-release downloads. Windows pre-release users likewise need Scoop or a
direct download — winget doesn't have a pre-release equivalent.

The in-app update check can also follow the pre-release channel:
**Settings → Updates → "Include pre-releases"** makes the boot-time
Expand All @@ -189,6 +220,7 @@ next pre-release just like it does on stable.
| Install path | Update command |
|---|---|
| Homebrew | `brew upgrade --cask baudrun` (or `baudrun@alpha`) |
| winget | `winget upgrade packetThrower.Baudrun` |
| Scoop | `scoop update baudrun` (or `baudrun-prerelease`) |
| `.deb` | `sudo apt install ./Baudrun_<new>_amd64.deb` |
| `.rpm` | `sudo dnf install ./Baudrun-<new>-1.x86_64.rpm` |
Expand All @@ -200,6 +232,7 @@ next pre-release just like it does on stable.
| Install path | Uninstall command |
|---|---|
| Homebrew | `brew uninstall --cask baudrun baudrun@alpha` |
| winget | `winget uninstall packetThrower.Baudrun` |
| Scoop | `scoop uninstall baudrun baudrun-prerelease` |
| Linux package | `sudo apt remove baudrun` / `sudo dnf remove baudrun` / `sudo pacman -R baudrun` |
| Direct download | drag `Baudrun.app` to Trash, run the uninstaller `Baudrun_<version>_x64-setup.exe /S` with `--uninstall`, or just delete the AppImage |
Expand Down