Skip to content

Commit 675c7bb

Browse files
committed
Update docs for end users
- Remove architecture docs (for developers, not users) - Update getting started with install instructions from README - Focus on user-facing content only
1 parent 7f05261 commit 675c7bb

File tree

2 files changed

+32
-31
lines changed

2 files changed

+32
-31
lines changed

docs/src/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@
22

33
- [Introduction](./intro.md)
44
- [Getting Started](./getting-started.md)
5-
- [Architecture](./architecture.md)

docs/src/getting-started.md

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,47 @@
11
# Getting Started
22

3-
## Installation
3+
## Downloads
44

5-
### Prerequisites
5+
### Development Builds
66

7-
- [Bun](https://bun.sh) - JavaScript runtime and package manager
8-
- Git
7+
Pre-built binaries are available from [GitHub Actions](https://github.com/coder/cmux/actions/workflows/build.yml):
98

10-
### Clone and Install
9+
- **macOS**: Universal binary DMG (Intel + Apple Silicon)
10+
- **Linux**: AppImage (portable, works on most distros)
1111

12-
```bash
13-
git clone https://github.com/ammarbandukwala/cmux.git
14-
cd cmux
15-
bun install
16-
```
12+
To download:
1713

18-
## Development
14+
1. Go to the [Build workflow](https://github.com/coder/cmux/actions/workflows/build.yml)
15+
2. Click on the latest successful run
16+
3. Scroll down to "Artifacts" section
17+
4. Download `macos-dmg` or `linux-appimage`
1918

20-
```bash
21-
# Start development server
22-
bun dev
19+
### Installation
2320

24-
# In another terminal, start Electron
25-
bun start
26-
```
21+
**macOS:**
2722

28-
## Building
23+
⚠️ **Note**: The app is unsigned, so you'll need to bypass Gatekeeper security.
2924

30-
```bash
31-
# Build the application
32-
bun run build
25+
1. Download and open the DMG file
26+
2. Drag Cmux to Applications folder
27+
3. **First time opening**:
28+
- Don't double-click the app (macOS will block it)
29+
- Right-click (or Control+click) on Cmux.app
30+
- Select "Open" from the menu
31+
- Click "Open" in the security dialog
32+
- The app will now be allowed to run
3333

34-
# Package for distribution
35-
bun run dist:mac # macOS
36-
bun run dist:linux # Linux
37-
```
34+
**Alternative method if the above doesn't work:**
3835

39-
## Configuration
36+
1. After step 2, open Terminal
37+
2. Run: `xattr -cr /Applications/Cmux.app`
38+
3. Run: `codesign --force --deep --sign - /Applications/Cmux.app`
39+
4. Now you can open the app normally
4040

41-
Configuration is stored in `~/.cmux/config.json` and includes:
41+
These steps are only needed once. After that, you can open the app normally.
4242

43-
- Active projects
44-
- Workspace settings
45-
- UI preferences
43+
**Linux:**
44+
45+
1. Download the AppImage file
46+
2. Make it executable: `chmod +x Cmux-*.AppImage`
47+
3. Run it: `./Cmux-*.AppImage`

0 commit comments

Comments
 (0)