Skip to content

Commit e14bdd0

Browse files
committed
Separate README and docs intro
- Break symlink: README and intro.md are now separate files - README is minimal and links to published docs - intro.md is comprehensive documentation welcome page - README focuses on quick start and links out
1 parent 49249fd commit e14bdd0

File tree

2 files changed

+49
-11
lines changed

2 files changed

+49
-11
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,31 @@
33
[![CI](https://github.com/coder/cmux/actions/workflows/ci.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/ci.yml)
44
[![Build](https://github.com/coder/cmux/actions/workflows/build.yml/badge.svg)](https://github.com/coder/cmux/actions/workflows/build.yml)
55

6-
A cross-platform desktop application for managing multiple coding agents.
6+
A cross-platform desktop application for AI-assisted development with git worktree integration.
77

8-
Key features:
9-
- Supports both OpenAI and Anthropic models with consistent interface
10-
- Workspace isolation with git worktrees
11-
- Much richer interface than traditional TUIs
12-
- E.g., ask the agent for an architecture diagram of your codebase
8+
## Documentation
139

14-
## Caveats
10+
📚 **[Read the full documentation →](https://coder.github.io/cmux)**
1511

16-
- Early stage, Alpha software
17-
- Built artifacts for macOS and Linux only
18-
- Majority of testing on `claude-sonnet-4-5`
12+
- [Installation](https://coder.github.io/cmux/install.html)
13+
- [Keyboard Shortcuts](https://coder.github.io/cmux/keybinds.html)
14+
- [Developer Guide](https://coder.github.io/cmux/AGENTS.html)
15+
16+
## Quick Install
17+
18+
Download pre-built binaries from [GitHub Actions artifacts](https://github.com/coder/cmux/actions/workflows/build.yml):
19+
20+
- **macOS**: Universal binary DMG (Intel + Apple Silicon)
21+
- **Linux**: AppImage
1922

2023
## Development
2124

2225
See [AGENTS.md](./AGENTS.md) for development setup and guidelines.
26+
27+
## Features
28+
29+
- 🔀 Git worktree integration for multi-branch workflows
30+
- 🤖 Multiple AI permission modes (plan/edit/yolo)
31+
- 📦 Multi-project management
32+
- 💬 Persistent session history
33+
- ⌨️ Keyboard-first interface

docs/src/intro.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/src/intro.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Introduction
2+
3+
**cmux** (Coding Agent Multiplexer) is a cross-platform desktop application for AI-assisted development with git worktree integration.
4+
5+
## What is cmux?
6+
7+
cmux helps you work with AI coding assistants more effectively by:
8+
9+
- 🔀 **Git Worktree Integration** - Work on multiple branches simultaneously without switching contexts
10+
- 🤖 **Multiple Permission Modes** - Control how aggressively the AI can modify your code (plan/edit/yolo)
11+
- 📦 **Project Management** - Organize and switch between multiple projects seamlessly
12+
- 💬 **Session History** - Full chat history persistence across sessions
13+
- 🔄 **Flexible Workflows** - Support for different AI models and providers
14+
15+
## Why cmux?
16+
17+
Traditional AI coding assistants require constant context switching between branches and can be disruptive to existing workflows. cmux solves this by leveraging git worktrees, allowing you to:
18+
19+
- Keep multiple feature branches active simultaneously
20+
- Isolate AI experiments from your main codebase
21+
- Maintain separate chat contexts for different tasks
22+
- Quickly switch between different AI models and configurations
23+
24+
## Quick Links
25+
26+
- [Install](./install.md) - Download and installation instructions
27+
- [Keyboard Shortcuts](./keybinds.md) - Complete keyboard reference
28+
- [AGENTS](./AGENTS.md) - Developer guide for AI assistants

0 commit comments

Comments
 (0)