Update README

This commit is contained in:
Bruno Sutic 2014-11-21 14:47:57 +01:00
parent e8401ba305
commit 9eae48b87e
No known key found for this signature in database
GPG Key ID: 66D96E4F2F7EF26C
2 changed files with 13 additions and 3 deletions

View File

@ -1,6 +1,8 @@
# Changelog # Changelog
### master ### master
- add link to the wiki page for "first pane/window issue" to the README as well
as other tweaks
### v1.5.0, 2014-11-09 ### v1.5.0, 2014-11-09
- add support for restoring neovim sessions - add support for restoring neovim sessions

View File

@ -46,7 +46,7 @@ This plugin goes to great lengths to save and restore all the details from your
[configuration section](#configuration). [configuration section](#configuration).
- restoring vim/neovim sessions (optional). More details in - restoring vim/neovim sessions (optional). More details in
[restoring vim and neovim sessions](#restoring-vim-and-neovim-sessions). [restoring vim and neovim sessions](#restoring-vim-and-neovim-sessions).
- restoring bash history (optional, *experimental*). More details in - restoring bash history (optional, \*experimental*). More details in
[restoring bash history](#restoring-bash-history-experimental). [restoring bash history](#restoring-bash-history-experimental).
Requirements / dependencies: `tmux 1.9` or higher, `bash`. Requirements / dependencies: `tmux 1.9` or higher, `bash`.
@ -54,6 +54,14 @@ Requirements / dependencies: `tmux 1.9` or higher, `bash`.
`tmux-resurrect` is idempotent! It will not try to restore panes or windows that `tmux-resurrect` is idempotent! It will not try to restore panes or windows that
already exist. already exist.
### FAQ
> I have a problem: first pane/window is not restoring!
Check out
[this wiki page](https://github.com/tmux-plugins/tmux-resurrect/wiki/Help:-issues-with-the-first-window)
for the explanation and problem solution.
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended) ### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
Add plugin to the list of TPM plugins in `.tmux.conf`: Add plugin to the list of TPM plugins in `.tmux.conf`:
@ -141,7 +149,7 @@ Change this with:
In `.tmux.conf`: In `.tmux.conf`:
set -g @resurrect-save-bash-history 'on' set -g @resurrect-save-bash-history 'on'
Bash `history` for individual panes will now be saved and restored. Due to Bash `history` for individual panes will now be saved and restored. Due to
technical limitations, this only works for panes which have no program running in technical limitations, this only works for panes which have no program running in
@ -166,7 +174,7 @@ Both contributing and bug reports are welcome. Please check out
### Credits ### Credits
[Mislav Marohnić](https://github.com/mislav) - the idea for the plugin came from his [Mislav Marohnić](https://github.com/mislav) - the idea for the plugin came from his
[tmux-session script](https://github.com/mislav/dotfiles/blob/master/bin/tmux-session). [tmux-session script](https://github.com/mislav/dotfiles/blob/2036b5e03fb430bbcbc340689d63328abaa28876/bin/tmux-session).
### Other ### Other