Move all the docs to `docs/` dir

Bruno Sutic 8 years ago
parent 27facedfd5
commit d57df1108d
No known key found for this signature in database
GPG Key ID: 66D96E4F2F7EF26C
  1. 1
  2. 5
  3. 12
  4. 14
  5. 20

@ -2,6 +2,7 @@
### master
- refactor `shared_set_tpm_path_constant` function
- move all instructions to `docs/` dir
### v2.0.0, 2015-07-07
- enable overriding default key bindings

@ -73,8 +73,9 @@ More advanced features and instructions, regular users probably do not need
- [How to create a plugin](docs/ It's easy.
- [Installing plugins via the command line](
- [Changing plugins install dir](
- [Installing plugins via the command line](docs/
- [Changing plugins install dir](docs/
- [Automatic TPM installation](docs/
### Tests

@ -0,0 +1,12 @@
# Automatic tpm installation
One of the first things we do on a new machine is cloning our dotfiles. Not everything comes with them though, so for example `tpm` most likely won't be installed.
If you wanna install `tpm` automatically when tmux is started, put the following snippet in `.tmux.conf` before the final `run '~/.tmux/plugins/tpm/tpm'`:
if "test ! -d ~/.tmux/plugins/tpm" \
"run 'git clone ~/.tmux/plugins/tpm'"
This useful tip was submitted by @acr4.

@ -0,0 +1,14 @@
# Changing plugins install dir
By default, TPM installs plugins to `~/.tmux/plugins/`.
You can change the install path by putting this in `.tmux.conf`:
set-environment -g TMUX_PLUGIN_MANAGER_PATH '/some/other/path/'
Tmux plugin manager initialization in `.tmux.conf` should also be updated:
# initializes TMUX plugin manager in a new path
run /some/other/path/tpm/tpm
Please make sure that the `run` line is at the very bottom of `.tmux.conf`.

@ -0,0 +1,20 @@
# Installing plugins via the command line only
### From inside tmux
When you have `tmux` running, plugins can be installed with the following command:
This is the equivalent of pressing `prefix + I`.
### From outside tmux
To install the plugins when `tmux` is not even started (for example in a provisioning script):
# start tmux and create a session but don't attach to it
tmux new-session -d
# install the plugins
tmux run "~/.tmux/plugins/tpm/scripts/"
# killing the session is not required
tmux kill-session