Skip to content

Commit 48fb55a

Browse files
committed
docs: update install
1 parent 91af608 commit 48fb55a

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# cmux - coding agent multiplexer
66

77
[![CI](https://github.com/coder/cmux/actions/workflows/ci.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/ci.yml)
8-
[![Build](https://github.com/coder/cmux/actions/workflows/build.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/build.yml)
8+
[![Build](https://github.com/coder/cmux/actions/workflows/build.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/build.yml?query=event:merge_group)
99
[![Download](https://img.shields.io/badge/Download-Releases-purple)](https://github.com/coder/cmux/releases)
1010
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL%203.0-blue.svg)](LICENSE)
1111

@@ -44,19 +44,18 @@ Here are some specific use cases we enable:
4444
UX. You'll find familiar features like Plan/Exec mode, VIM inputs, `/compact` and new ones
4545
like [opportunistic compaction](https://cmux.io/context-management.html) and [mode prompts](https://cmux.io/instruction-files.html#mode-prompts).
4646

47-
📚 **[Read the full documentation →](https://cmux.io)**
47+
**[Read the full documentation →](https://cmux.io)**
4848

49-
## Quick Install
49+
## Install
5050

5151
> [!WARNING]
5252
> cmux is in a Preview state. You will encounter bugs and performance issues.
5353
> It's still possible to be highly productive. We are using it almost exclusively for our own development.
5454
55-
Download pre-built binaries from [the releases page](https://github.com/coder/cmux/releases):
55+
Download pre-built binaries from [the releases page](https://github.com/coder/cmux/releases) for
56+
macOS and Linux.
5657

57-
- **macOS**: Signed and notarized DMG (separate builds for Intel/Apple Silicon)
58-
- **Linux**: AppImage
59-
- **Windows**: not implemented, coming soon
58+
[More on installation →](https://cmux.io/install.html)
6059

6160
## Screenshots
6261

docs/install.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ Download pre-built binaries from [the releases page](https://github.com/coder/cm
88

99
- **macOS**: Signed and notarized DMG (separate builds for Intel/Apple Silicon)
1010
- **Linux**: AppImage
11-
- **Windows**: not implemented, coming soon
1211

1312
### Development Builds
1413

15-
Pre-built binaries are available from [GitHub Actions](https://github.com/coder/cmux/actions/workflows/build.yml):
14+
Down pre-built binaries of `main` from [GitHub Actions](https://github.com/coder/cmux/actions/workflows/build.yml):
1615

1716
- **macOS**: Signed and notarized DMG
1817
- `macos-dmg-x64` (Intel Macs)
@@ -21,7 +20,7 @@ Pre-built binaries are available from [GitHub Actions](https://github.com/coder/
2120

2221
To download:
2322

24-
1. Go to the [Build workflow](https://github.com/coder/cmux/actions/workflows/build.yml)
23+
1. Go to the [Build workflow](https://github.com/coder/cmux/actions/workflows/build.yml?query=event:merge_group)
2524
2. Click on the latest successful run
2625
3. Scroll down to "Artifacts" section
2726
4. Download the appropriate artifact for your platform

0 commit comments

Comments
 (0)