Skip to content

Commit e69d93c

Browse files
author
Bruno Sutic
committed
Add installation instructions to the readme
1 parent 7c6be03 commit e69d93c

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- add links to related plugins to the readme
77
- add screencast script to the repo
88
- add screencast video link to the README
9+
- add installation instructions
910

1011
### v0.0.2, Aug 02, 2014
1112
- add readme

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,35 @@ In copy mode:
2525

2626
[![screencast screenshot](/video/screencast_img.png)](http://vimeo.com/102455265)
2727

28+
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
29+
30+
Add plugin to the list of TPM plugins in `.tmux.conf`:
31+
32+
set -g @tpm_plugins " \
33+
tmux-plugins/tpm \
34+
tmux-plugins/tmux-open \
35+
"
36+
37+
Hit `prefix + I` to fetch the plugin and source it. You should now be able to
38+
use the plugin.
39+
40+
### Manual Installation
41+
42+
Clone the repo:
43+
44+
$ git clone https://github.com/tmux-plugins/tmux-open ~/clone/path
45+
46+
Add this line to the bottom of `.tmux.conf`:
47+
48+
run-shell ~/clone/path/open.tmux
49+
50+
Reload TMUX environment:
51+
52+
# type this in terminal
53+
$ tmux source-file ~/.tmux.conf
54+
55+
You should now be able to use the plugin.
56+
2857
### Other goodies
2958

3059
`tmux-open` works great with:

0 commit comments

Comments
 (0)