mirror of
https://github.com/tmux-plugins/tpm.git
synced 2024-12-04 18:58:49 +00:00
Update readme with new plugin syntax
This commit is contained in:
parent
7ce0326916
commit
343ae423dd
45
README.md
45
README.md
@ -12,44 +12,43 @@ Clone TPM:
|
||||
|
||||
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
|
||||
|
||||
Put this at the bottom of your `.tmux.conf` (backslashes at the end of the lines
|
||||
are required):
|
||||
Put this at the bottom of `.tmux.conf`:
|
||||
|
||||
# List of plugins
|
||||
# Supports `github_username/repo` or full git repo URLs
|
||||
set -g @tpm_plugins ' \
|
||||
tmux-plugins/tpm \
|
||||
tmux-plugins/tmux-sensible \
|
||||
'
|
||||
# Other examples:
|
||||
# github_username/plugin_name \
|
||||
# git@github.com/user/plugin \
|
||||
# git@bitbucket.com/user/plugin \
|
||||
set -g @plugin 'tmux-plugins/tpm'
|
||||
set -g @plugin 'tmux-plugins/tmux-sensible'
|
||||
|
||||
# Initializes TMUX plugin manager.
|
||||
# Keep this line at the very bottom of tmux.conf.
|
||||
run-shell '~/.tmux/plugins/tpm/tpm'
|
||||
# Other examples:
|
||||
# set -g @plugin 'github_username/plugin_name'
|
||||
# set -g @plugin 'git@github.com/user/plugin'
|
||||
# set -g @plugin 'git@bitbucket.com/user/plugin'
|
||||
|
||||
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
|
||||
run '~/.tmux/plugins/tpm/tpm'
|
||||
|
||||
Reload TMUX environment so TPM is sourced:
|
||||
|
||||
# type this in terminal
|
||||
$ tmux source-file ~/.tmux.conf
|
||||
$ tmux source ~/.tmux.conf
|
||||
|
||||
That's it!
|
||||
|
||||
(**Note:** using `set -g @tpm_plugins` is deprecated, but still works alongside
|
||||
new syntax)
|
||||
|
||||
### Installing plugins
|
||||
|
||||
1. add a new plugin to the `@tpm_plugins` list
|
||||
2. hit `prefix + I` (I as in *I*nstall) to fetch the plugin
|
||||
1. add new plugin to `.tmux.conf` with `set -g @plugin '...'`
|
||||
2. hit `prefix + I` (I as in **I**nstall) to fetch the plugin
|
||||
|
||||
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
|
||||
|
||||
### Uninstalling plugins
|
||||
|
||||
1. remove plugin from `@tpm_plugins` list
|
||||
2. hit `prefix + alt + u` (u as in *u*install) to remove the plugin
|
||||
1. remove (or comment out) plugin from the list
|
||||
2. hit `prefix + alt + u` (u as in **u**install) to remove the plugin
|
||||
|
||||
All the plugins are installed to `~/.tmux/plugins/` so if you want you can just
|
||||
All the plugins are installed to `~/.tmux/plugins/` so alternatively you can
|
||||
find plugin directory there and remove it.
|
||||
|
||||
### Key bindings
|
||||
@ -62,9 +61,9 @@ find plugin directory there and remove it.
|
||||
- updates plugin(s)
|
||||
|
||||
`prefix + alt + u`
|
||||
- uninstall unused plugin(s)
|
||||
- uninstall plugins that are not on the plugin list
|
||||
|
||||
### List of plugins
|
||||
### More plugins
|
||||
|
||||
For more plugins, check [here](https://github.com/tmux-plugins).
|
||||
|
||||
@ -81,7 +80,7 @@ More advanced features, regular users probably do not need this:
|
||||
|
||||
### Tests
|
||||
|
||||
Tests run on [travis](https://travis-ci.org/tmux-plugins/tpm).
|
||||
Tests for this project run on [travis](https://travis-ci.org/tmux-plugins/tpm).
|
||||
|
||||
When run locally, [vagrant](https://www.vagrantup.com/) is required.
|
||||
Run tests with:
|
||||
|
Loading…
Reference in New Issue
Block a user