Skip to content

Commit a1936e8

Browse files
chore: update readme with tmux
1 parent c45ea5e commit a1936e8

File tree

2 files changed

+47
-3
lines changed

2 files changed

+47
-3
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,50 @@ Press `Ctrl+L` in the affected pane to clear the screen.
187187
- **One feature per pane** for clean separation of work
188188
- **Close unused panes** with `x` to keep the interface clean
189189

190+
## tmux Configuration for Beginners
191+
192+
While cmux handles most tmux operations automatically, having a good tmux configuration can enhance your experience. This isn't the place to learn tmux comprehensively, but here's a helpful configuration to get you started.
193+
194+
### Recommended tmux Configuration
195+
196+
Add this to your `~/.tmux.conf` file:
197+
198+
```bash
199+
# Visual distinction between active and inactive panes
200+
set -g window-style 'fg=colour247,bg=colour236'
201+
set -g window-active-style 'fg=default,bg=colour234'
202+
203+
# Pane borders
204+
set -g pane-border-style "fg=colour238 bg=default"
205+
set -g pane-active-border-style "fg=blue bg=default"
206+
207+
# Status bar styling
208+
set -g status-style 'bg=colour236'
209+
210+
# Keyboard shortcuts for pane navigation
211+
# Hold Ctrl+Shift and use arrow keys to move between panes
212+
bind -n C-S-Left select-pane -L
213+
bind -n C-S-Right select-pane -R
214+
bind -n C-S-Up select-pane -U
215+
bind -n C-S-Down select-pane -D
216+
217+
# Enable mouse support (click panes, resize with mouse)
218+
set -g mouse on
219+
```
220+
221+
### Key Features of This Configuration
222+
223+
- **Visual Feedback**: Active panes have a darker background and blue border
224+
- **Easy Navigation**: Hold `Ctrl+Shift` and use arrow keys to switch between panes instantly
225+
- **Mouse Support**: Click on panes to focus them, drag borders to resize
226+
227+
After adding this configuration, reload tmux:
228+
```bash
229+
tmux source-file ~/.tmux.conf
230+
```
231+
232+
Or start a new tmux session for the changes to take effect.
233+
190234
## Requirements Summary
191235

192236
- tmux ≥ 3.0

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@
4848
"typecheck": "tsc --noEmit",
4949
"prepublishOnly": "pnpm run build",
5050
"prerelease": "run-s clean typecheck build",
51-
"release": "bumpp --commit --push --tag",
52-
"release:minor": "bumpp minor --commit --push --tag",
53-
"release:major": "bumpp major --commit --push --tag"
51+
"release": "bumpp --commit --push --tag && pnpm publish",
52+
"release:minor": "bumpp minor --commit --push --tag && pnpm publish",
53+
"release:major": "bumpp major --commit --push --tag && pnpm publish"
5454
},
5555
"bin": {
5656
"dmux": "./dmux"

0 commit comments

Comments
 (0)