summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNaz <ndpm13@ch-naseem.com>2025-02-09 17:04:47 +0100
committerNaz <ndpm13@ch-naseem.com>2025-02-09 17:04:47 +0100
commitb0414205164a07276bb0f311c2db811406ab0c2c (patch)
tree4cb1bfc5c3f539fc4178044b66ca94c2f5f24df7
parentf5c9b8bd4c5eb183fb52fdf1bc508b4e4f7fd7d6 (diff)
📚docs: update readme
-rw-r--r--README.md26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.md b/README.md
index f9f6d95..18fd1d2 100644
--- a/README.md
+++ b/README.md
@@ -2,40 +2,48 @@
Retro groove colorscheme for [tmux](https://github.com/tmux/tmux), based on the excellent [gruvbox](https://github.com/morhetz/gruvbox) theme for vim.
-<img src="https://i.imgur.com/6IQCia6.png" style="width: 100%; max-width: 600px; text-align: center;"/>
+![](https://files.catbox.moe/e8utrq.jpg)
-This is a heavily modified fork of [tmux-gruvbox](https://github.com/egel/tmux-gruvbox).
+![](https://files.catbox.moe/cmh8tl.jpg)
-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 `vi`), the statusbar will indicate its mode while being edited
-- Highlights unfocused windows with activity or terminal bells
-- Does not use custom glyphs
+This is a modified fork of [tmux-gruvbox-truecolor](https://github.com/LawAbidingCactus/tmux-gruvbox-truecolor).
## Installation
+
### Manual
+
Just clone this repo and add `tmux-colorscheme.conf` to your `.tmux.conf`:
+
```bash
cat tmux-colorscheme.conf >> ~/.tmux.conf
```
+
Or move `tmux-colorscheme.conf` to your home directory and source it in `.tmux.conf`:
+
```tmux
source-file ~/tmux-colorscheme.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'
+set -g @plugin 'ndpm13/tmux-gruvbox-truecolor'
```
+
Press `<prefix> + I` to reload tmux with the plugin.
## Troubleshooting
+
### tmux's colors look weird
+
Try adding the following to your `.tmux.conf`:
+
```tmux
set-option -as terminal-overrides ",xterm*:RGB"
```
### Pane separator lines look weird
+
Something isn't correctly handling UTF-8 line drawing characters.