Skip to content

Commit 04337fd

Browse files
author
Bruno Sutic
committedJul 30, 2014
Add readme
1 parent 1e1f7e0 commit 04337fd

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed
 

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22

33
### master
44
- initial work on the plugin
5+
- add readme

‎README.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Tmux sensible
2+
3+
A set of tmux options that should be acceptable for everyone.
4+
5+
Inspired by [vim-sensible](https://github.com/tpope/vim-sensible).
6+
7+
### Principles
8+
9+
- `tmux-sensible` options should be acceptable to **every** tmux user!<br/>
10+
If any option bothers you, please open an issue and it will probably be
11+
updated (or removed).
12+
- if you think a new option should be added, feel free to open a pull request.
13+
- **no overriding** of user defined settings.<br/>
14+
Your existing `.tmux.conf` settings are respected and they won't be changed.
15+
That way you can use `tmux-sensible` if you have a few specific options.
16+
See [feature section](#example-feature) for an example.
17+
- [source code](https://github.com/tmux-plugins/tmux-sensible/blob/master/sensible.tmux)
18+
is the authoritative documentation.<br/>
19+
It's really not that scary and you should have a look, even if you're a
20+
tmux beginner.
21+
22+
### Goals
23+
24+
- group standard tmux community options in one place
25+
- remove clutter from your `.tmux.conf`
26+
- educate new tmux users about basic options
27+
28+
### Example feature
29+
30+
Sets tmux prefix to `Ctrl-a`.
31+
32+
# set prefix to `Ctrl-a`
33+
tmux set-option -g prefix C-a
34+
tmux unbind-key C-b
35+
36+
Since user defined `.tmux.conf` settings are respected, if prefix is set to
37+
`Ctrl-z` - it won't be overriden!
38+
39+
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
40+
41+
Add plugin to the list of TPM plugins in `.tmux.conf`:
42+
43+
set -g @tpm_plugins " \
44+
tmux-plugins/tpm \
45+
tmux-plugins/tmux-sensible \
46+
"
47+
48+
Hit `prefix + I` to fetch the plugin and source it. That's it!
49+
50+
You might also want to restart your tmux server, just in case.
51+
52+
### Manual Installation
53+
54+
Clone the repo:
55+
56+
$ git clone https://github.com/tmux-plugins/tmux-sensible ~/clone/path
57+
58+
Add this line to the bottom of `.tmux.conf`:
59+
60+
run-shell ~/clone/path/sensible.tmux
61+
62+
Reload TMUX environment:
63+
64+
# type this in terminal
65+
$ tmux source-file ~/.tmux.conf
66+
67+
You might also want to restart your tmux server, just in case.
68+
69+
### Other goodies
70+
71+
You might also find these useful:
72+
73+
- [copycat](https://github.com/tmux-plugins/tmux-copycat)
74+
improve tmux search and reduce mouse usage
75+
- [pain control](https://github.com/tmux-plugins/tmux-pain-control)
76+
useful standard bindings for controlling panes
77+
78+
### License
79+
80+
[MIT](LICENSE.md)

0 commit comments

Comments
 (0)
Failed to load comments.