Skip to content

Commit e08ddfd

Browse files
committed
🤖 docs: add Windows installation instructions
- Add Windows installer exe to release builds list - Add Windows installation steps - Clarify that Windows builds are only available from releases (not dev builds) - Fix typo: 'Down' -> 'Download'
1 parent 4eef087 commit e08ddfd

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/install.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,19 @@ Download pre-built binaries from [the releases page](https://github.com/coder/mu
88

99
- **macOS**: Signed and notarized DMG (separate builds for Intel/Apple Silicon)
1010
- **Linux**: AppImage
11+
- **Windows**: Installer exe
1112

1213
### Development Builds
1314

14-
Down pre-built binaries of `main` from [GitHub Actions](https://github.com/coder/mux/actions/workflows/build.yml):
15+
Download pre-built binaries of `main` from [GitHub Actions](https://github.com/coder/mux/actions/workflows/build.yml):
1516

1617
- **macOS**: Signed and notarized DMG
1718
- `macos-dmg-x64` (Intel Macs)
1819
- `macos-dmg-arm64` (Apple Silicon)
1920
- **Linux**: AppImage (portable, works on most distros)
2021

22+
> **Note**: Windows builds are only available from [releases](https://github.com/coder/mux/releases), not from development builds.
23+
2124
To download:
2225

2326
1. Go to the [Build workflow](https://github.com/coder/mux/actions/workflows/build.yml?query=event:merge_group)
@@ -44,6 +47,13 @@ The app is code-signed and notarized by Apple, so it will open without security
4447
2. Make it executable: `chmod +x Mux-*.AppImage`
4548
3. Run it: `./Mux-*.AppImage`
4649

50+
**Windows:**
51+
52+
1. Download the installer exe from [releases](https://github.com/coder/mux/releases) (e.g., `mux-x.x.x-x64.exe`)
53+
2. Run the installer
54+
3. Follow the installation prompts
55+
4. Launch Mux from the Start menu or desktop shortcut
56+
4757
### Testing Pre-Release Builds
4858

4959
⚠️ **Note**: Only builds from the `main` branch are signed and notarized. If you're testing a build from a pull request or other branch, you'll need to bypass macOS Gatekeeper:

0 commit comments

Comments
 (0)