From 5c026623a416105881dca56401c8845c1b973c8e Mon Sep 17 00:00:00 2001 From: Determinant Date: Wed, 20 May 2020 15:58:32 -0400 Subject: add README --- README.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a52981f --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +Tmux ColorTag theme +------------------- + +What's This? +============ + +This is a very succinct theme that colors the window tags according to their +names. This means with a proper ``status-interval`` set in your tmux (see +below), it can even automatically change when various programs in your shell +runs! + +Installation +============ + +- Add plugin to the list of TPM plugins in ``.tmux.conf``: + + :: + + set -g @plugin 'Determinant/tmux-colortag' + +- Hit prefix + I to fetch the plugin and source it. + +- Optional: for the best experience, try to use a short status update interval: + + :: + + set -g status-interval 2 + +- Optional: if you don't like powerline symbols, feel free to change them by + specifying the following environment variables to override the default: + + - ``TMUX_ARROW_SYMBOL_L1`` + - ``TMUX_ARROW_SYMBOL_L2`` + - ``TMUX_ARROW_SYMBOL_R1`` + - ``TMUX_ARROW_SYMBOL_R2`` -- cgit v1.2.3