Skip to content

Commit 62bb7bb

Browse files
committed
feat: Improve README.md with better configuration and environment variable documentation
1 parent 2386adc commit 62bb7bb

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,46 @@
44

55
### Installation
66

7-
Clone TPM
87
`$ git clone https://github.com/ddzero2c/tmux-easymotion.git ~/.tmux-easymotion`
98

10-
Put this at the bottom of ~/.tmux.conf
9+
### Configuration
1110

12-
```
11+
```bash
12+
# Basic binding
1313
bind s run-shell "tmux neww ~/.tmux-easymotion/easymotion.py"
14-
```
1514

16-
### Key bindings
17-
`prefix` + `s` -> hit a character -> hit hints (jump to position) -> press `ve` and `y` to copy
15+
# Or with custom environment variables
16+
bind s run-shell "tmux neww TMUX_EASYMOTION_KEYS='asdfjkl;' ~/.tmux-easymotion/easymotion.py"
1817

19-
`prefix` + `]` to paste
20-
21-
Configure vim-like movement:
22-
```
23-
# .tmux.conf
18+
# Vim-like binding
2419
set-window-option -g mode-keys vi
2520
bind-key -T copy-mode-vi C-v send-keys -X begin-selection \; send-keys -X rectangle-toggle;
2621
bind-key -T copy-mode-vi v send-keys -X begin-selection;
2722
bind-key -T copy-mode-vi V send-keys -X select-line;
2823
```
2924

25+
Available environment variables(default values):
26+
```bash
27+
# Keys used for hints
28+
TMUX_EASYMOTION_KEYS="asdfghjkl;"
29+
30+
# Border characters
31+
TMUX_EASYMOTION_VERTICAL_BORDER=""
32+
TMUX_EASYMOTION_HORIZONTAL_BORDER=""
33+
34+
# Debug mode - writes debug info to ~/easymotion.log
35+
TMUX_EASYMOTION_DEBUG="false"
36+
37+
# Performance logging - writes timing info to ~/easymotion.log
38+
TMUX_EASYMOTION_PERF="false"
39+
```
40+
41+
### Usage
42+
`prefix` + `s` -> hit a character -> hit hints (jump to position) -> press `ve` and `y` to copy
43+
44+
`prefix` + `]` to paste
45+
46+
3047
### Run tests
3148

3249
```bash

0 commit comments

Comments
 (0)