Add readme

Close #8
This commit is contained in:
Bruno Sutic 2014-08-26 16:07:04 +02:00
parent 81ed0811b4
commit c993e9ff00
No known key found for this signature in database
GPG Key ID: 66D96E4F2F7EF26C
2 changed files with 37 additions and 0 deletions

View File

@ -5,6 +5,7 @@
- make the directory where sessions are stored configurable - make the directory where sessions are stored configurable
- support only Tmux v1.9 or greater - support only Tmux v1.9 or greater
- display a nice error message if saved session file does not exist - display a nice error message if saved session file does not exist
- added README
### v0.0.1, 2014-08-26 ### v0.0.1, 2014-08-26
- started a project - started a project

View File

@ -1,4 +1,40 @@
# Tmux Session Saver # Tmux Session Saver
Enables saving and restoring of tmux sessions.
### Key bindings
- `prefix + M-s` - save
- `prefix + M-r` - restore
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
Add plugin to the list of TPM plugins in `.tmux.conf`:
set -g @tpm_plugins " \
tmux-plugins/tpm \
tmux-plugins/tmux-session-saver \
"
Hit `prefix + I` to fetch the plugin and source it. You should now be able to
use the plugin.
### Manual Installation
Clone the repo:
$ git clone https://github.com/tmux-plugins/tmux-session-saver ~/clone/path
Add this line to the bottom of `.tmux.conf`:
run-shell ~/clone/path/session_saver.tmux
Reload TMUX environment:
# type this in terminal
$ tmux source-file ~/.tmux.conf
You should now be able to use the plugin.
### License ### License
[MIT](LICENSE.md) [MIT](LICENSE.md)