From b231f4b49785e93eda0341c24c626be9f2e082e3 Mon Sep 17 00:00:00 2001 From: Determinant Date: Fri, 22 May 2020 13:21:17 -0400 Subject: improve readme --- README.rst | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 8b9cbd2..f123485 100644 --- a/README.rst +++ b/README.rst @@ -7,12 +7,12 @@ Tmux ColorTag Theme -Also...works for powerline haters using the default setting. +Also works for powerline haters with default setting. .. raw:: html
- +
What's This? @@ -29,12 +29,25 @@ Features - Automically color the window tabs by their name hash - Allow manual coloring +TLDR; I just want it +==================== + +- Paste the following to your new ``~/.tmux.conf``: + :: + + set -g @plugin 'tmux-plugins/tpm' + set -g @plugin 'tmux-plugins/tmux-sensible' + set -g @plugin 'tmux-plugins/tmux-colortag' + run -b '~/.tmux/plugins/tpm/tpm' + +- Run ``tmux``, and then hit ``prefix`` + ``I`` so everything should be ready. + Installation ============ - Make sure you have tmux plugin manager installed: https://github.com/tmux-plugins/tpm -- Add plugin to the list of TPM plugins in ``.tmux.conf``: +- Add it to the list of TPM plugins in ``.tmux.conf``: :: @@ -65,6 +78,8 @@ Customization TMUX_COLORTAG_USE_POWERLINE=yes +- To change the prompt key (``prefix`` + C), specify your key in ``TMUX_COLORTAG_KEY``. + - If you don't like the existing powerline symbols, feel free to change them by specifying the following environment variables to override the default: -- cgit v1.2.3