diff options
| author | LawAbidingCactus <lawabidingcactus@lawabidingcactus.com> | 2020-01-02 23:23:06 +0000 |
|---|---|---|
| committer | LawAbidingCactus <lawabidingcactus@lawabidingcactus.com> | 2020-01-02 23:29:29 +0000 |
| commit | d9d149578c059a88f3c23b537c5ef1f9a3cac237 (patch) | |
| tree | c1afbfb42528d1261acc6c93bd6958bcec585a49 | |
| parent | ab9ee9a965bdbc227e551d8966a8d2387dc3955a (diff) | |
add readme
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9ff0682 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Gruvbox colorscheme for tmux + +Retro groove colorscheme for [tmux](https://github.com/tmux/tmux), based on the excellent [gruvbox](https://github.com/morhetz/gruvbox) theme for Vim. + +This is a heavily modified fork of [tmux-gruvbox](https://github.com/egel/tmux-gruvbox). + +Features/Differences: +- Uses gruvbox's hexadecimal colors (most terminal emulators have truecolor support) +- Indicates when the prefix key has been pressed +- If vi-mode is enabled (if `$EDITOR` contains `vim`), the statusbar will indicate its mode while being edited +- Highlights unfocused windows with activity or terminal bells +- Does not use custom glyphs + +## Installation +### Manual +Just clone this repo and add `tmux-colorscheme.conf` to your `.tmux.conf`: +```bash +cat tmux-colorscheme.conf >> ~/.tmux.conf +``` +### Tmux Plugin Manager +Add this repo to the list of [TPM](https://github.com/tmux-plugins/tpm) plugins in your `.tmux.conf`: +```tmux +set -g @plugin 'lawabidingcactus/tmux-gruvbox-truecolor' +``` +Press `<prefix> + I` to reload tmux with the plugin. |