Skip to content

Commit e768049

Browse files
committed
docs: update readme
1 parent 4d7b95c commit e768049

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# One Man Band
22

3-
> I vibe-coded the crap out of this.
3+
A GUI git worktree orchestrator, primarily for AI-driven development. Heavily inspired by [Conductor](https://docs.conductor.build) and [Worktrunk](https://worktrunk.dev), with more focus on simplicity.
44

5-
A desktop application for macOS that orchestrates git worktrees and launches Claude Code CLI instances in each.
5+
> I vibe-coded the crap out of this.
66
77
## Features
88

@@ -42,6 +42,7 @@ npm run tauri build
4242
```
4343

4444
The built application will be available at:
45+
4546
- `src-tauri/target/release/bundle/macos/One Man Band.app`
4647
- `src-tauri/target/release/bundle/dmg/One Man Band_*.dmg`
4748

@@ -74,14 +75,6 @@ The built application will be available at:
7475
└─────────────────────────────────────────────────────────────┘
7576
```
7677

77-
## Usage
78-
79-
1. **Add a Project**: Click the + button in the sidebar and select a git repository
80-
2. **Create a Workspace**: Click "Add workspace" under a project to create a new worktree
81-
3. **Start Working**: Select a workspace to open Claude Code CLI in that worktree
82-
4. **View Changes**: The right panel shows files changed in the active workspace
83-
5. **Terminal Access**: Use the terminal in the right panel for shell commands
84-
8578
## Data Storage
8679

8780
- **Workspaces**: Created in `<repo>/.worktrees/<workspace-name>/` by default
@@ -96,36 +89,37 @@ Settings are stored in `~/.config/onemanband/config.jsonc`. The file is created
9689
// Main terminal pane
9790
"main": {
9891
"fontFamily": "Menlo, Monaco, 'Courier New', monospace",
99-
"fontSize": 13
92+
"fontSize": 13,
10093
},
10194

10295
// Shell terminal (bottom-right pane)
10396
"terminal": {
10497
"fontFamily": "Menlo, Monaco, 'Courier New', monospace",
105-
"fontSize": 13
98+
"fontSize": 13,
10699
},
107100

108101
// Worktree settings
109102
"worktree": {
110103
// Directory for worktrees. Final path: {directory}/{workspace_name}
111104
// Supports placeholder: {{ repo_directory }} (the repo directory)
112105
// Default: "{{ repo_directory }}/.worktrees"
113-
"directory": null,
106+
"directory": "{{ repo_directory }}/.worktrees",
114107

115108
// Copy settings for new worktrees
116109
"copy": {
117110
// Copy gitignored files (e.g., .env, node_modules)
118111
"gitIgnored": false,
119112
// Glob patterns to exclude from copying
120-
"except": [".claude"]
121-
}
122-
}
113+
"except": [".claude"],
114+
},
115+
},
123116
}
124117
```
125118

126119
### Terminal Options
127120

128121
Both `main` and `terminal` sections support:
122+
129123
- **fontFamily**: CSS font-family string for the terminal
130124
- **fontSize**: Font size in pixels
131125

0 commit comments

Comments
 (0)