Ver Fonte

add readme

LawAbidingCactus há 5 anos atrás
pai
commit
d9d149578c
1 ficheiros alterados com 25 adições e 0 exclusões
  1. 25 0
      README.md

+ 25 - 0
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.