Skip to content

Commit a51730e

Browse files
author
Bruno Sutic
committed
Readme update
1 parent c69443d commit a51730e

File tree

2 files changed

+30
-29
lines changed

2 files changed

+30
-29
lines changed

README.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -62,29 +62,6 @@ Copying a highlighted match will take you "out" of copycat mode. Paste with
6262
Copying highlighted matches can be enhanced with
6363
[tmux yank](https://github.com/tmux-plugins/tmux-yank).
6464

65-
### Limitations
66-
67-
- This plugin tries hard to consistently enable "marketed" features. It uses some
68-
hacks to go beyond the APIs Tmux provides. Because of this, it might have some
69-
"rough edges" and there's nothing that can be done.
70-
71-
Examples: non-perfect file and url matching and selection. That said, usage
72-
should be fine in +90% cases.
73-
74-
- feel free to report search cases you think should work, but are not
75-
(provide examples pls!). I'm open to the idea of adding more saved searches.
76-
77-
- Tmux `vi` copy mode works faster than `emacs`. If you don't have a preference
78-
yet and to speed up `tmux_copycat`, I recommend putting this in `.tmux.conf`
79-
to set Tmux copy mode to `vi`:
80-
81-
set -g mode-keys vi
82-
83-
- remapping `Escape` key in copy mode will break the plugin. If you have this
84-
in your `.tmux.conf`, please consider removing it:
85-
86-
bind -t vi-copy Escape cancel
87-
8865
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
8966

9067
Add plugin to the list of TPM plugins in `.tmux.conf`:
@@ -107,16 +84,17 @@ Add this line to the bottom of `.tmux.conf`:
10784

10885
run-shell ~/clone/path/copycat.tmux
10986

110-
Reload TMUX environment:
111-
112-
# type this in terminal
113-
$ tmux source-file ~/.tmux.conf
114-
115-
You should now be able to use the plugin.
87+
Reload TMUX environment with: `$ tmux source-file ~/.tmux.conf`. You should now
88+
be able to use the plugin.
11689

11790
Optional (but recommended) install `gawk` via your package manager of choice
11891
for better UTF-8 character support.
11992

93+
### Limitations
94+
95+
This plugin has some known limitations. Please read about it
96+
[here](docs/limitations.md).
97+
12098
### Docs
12199

122100
- Most of the behavior of tmux-copycat can be customized via tmux options.

docs/limitations.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Limitations
2+
3+
- This plugin tries hard to consistently enable "marketed" features. It uses some
4+
hacks to go beyond the APIs Tmux provides. Because of this, it might have some
5+
"rough edges" and there's nothing that can be done.
6+
7+
Examples: non-perfect file and url matching and selection. That said, usage
8+
should be fine in +90% cases.
9+
10+
- feel free to report search cases you think should work, but are not
11+
(provide examples pls!). I'm open to the idea of adding more saved searches.
12+
13+
- Tmux `vi` copy mode works faster than `emacs`. If you don't have a preference
14+
yet and to speed up `tmux_copycat`, I recommend putting this in `.tmux.conf`
15+
to set Tmux copy mode to `vi`:
16+
17+
set -g mode-keys vi
18+
19+
- remapping `Escape` key in copy mode will break the plugin. If you have this
20+
in your `.tmux.conf`, please consider removing it:
21+
22+
bind -t vi-copy Escape cancel
23+

0 commit comments

Comments
 (0)