From 1ca0bea7a9833e656671f6ebd86e487d0fe471c5 Mon Sep 17 00:00:00 2001 From: Alexey Samoshkin Date: Thu, 23 Nov 2017 00:48:58 +0200 Subject: [PATCH] Change installation instructions in readme. Do not install tmux plugins until fixed --- install.sh | 4 ++-- readme.md | 14 +++++++++----- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/install.sh b/install.sh index 17c848d..d9d3525 100755 --- a/install.sh +++ b/install.sh @@ -30,8 +30,8 @@ rsync -aq ./tmux/ "$HOME"/.tmux ln -sf --backup --suffix=.bak .tmux/tmux.conf "$HOME"/.tmux.conf; -# BUG: Fix for fresh installation -"$HOME"/.tmux/plugins/tpm/bin/install_plugins +# BUG: Fix TPM and tmux plugins for fresh installation +# "$HOME"/.tmux/plugins/tpm/bin/install_plugins printf "$(tput setaf 2)OK:$(tput sgr0) Completed\n" diff --git a/readme.md b/readme.md index 843be66..4d6f125 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ -Tmux 2 Configuration +Tmux Configuration ===================== -Tmux configuration, that supercharges your "tmux" terminal environment, and make you feel like a boss. +Tmux configuration, that supercharges your [tmux](https://tmux.github.io/) to build cozy and cool terminal environment. ![intro](https://user-images.githubusercontent.com/768858/33152741-ec5f1270-cfe6-11e7-9570-6d17330a83aa.gif) @@ -26,7 +26,7 @@ Features - merge current session with existing one (move all windows) - integration with 3rd party plugins: [tmux-sidebar](https://github.com/tmux-plugins/tmux-sidebar), [tmux-copycat](https://github.com/tmux-plugins/tmux-copycat), [tmux-open](https://github.com/tmux-plugins/tmux-open), [tmux-plugin-sysstat](https://github.com/samoshkin/tmux-plugin-sysstat) -TBD: +**TBD**: - [ ] retain current path when new pane is created - [ ] integration with clipboard - [ ] fix pane resizing @@ -35,14 +35,18 @@ TBD: Installation ------------- -The prerequisite is to install tmux >= "2.4". +The prerequisite is installed tmux >= "2.4" and [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) ``` $ git clone https://github.com/samoshkin/tmux-config.git $ ./tmux-config/install.sh ``` -Installation script will copy files to `~/.tmux` directory, symlink main `~/.tmux` config file, install Tmux plugin manager (if not already installed), install configured tmux plugins. If you already have existing `~/tmux.conf`, backup will be created. +Installation script will copy files to `~/.tmux` directory, symlink main `~/.tmux` config file. If you already have existing `~/tmux.conf`, backup will be created. + +Note, that after you launch tmux, plugins needs to be installed. Hit `C-a Shift-i` keybinding to install all tmux plugins. + +- [ ] **TODO:** automate TPM and tmux plugin installation General settings