summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2019-06-26 14:57:58 -0400
committerDan Davison <dandavison7@gmail.com>2019-06-26 14:57:58 -0400
commitd682e2fdad335ca189ec0630d6a78243bcfadd5e (patch)
tree51d2a679613eff866a2fb9e55de66a494a3274c4 /README.md
parent371a342d12e842347fa49522796795eabd181642 (diff)
Add notes about 24 bit color to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index e2e038ed..52bc16ec 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,11 @@
## Installation
+#### 0. Use a terminal that supports 24 bit colors
+ See https://gist.github.com/XVilka/8346728
+
+ For example, on macos, iTerm2 works but Terminal.app does not. If you are using tmux, see the section at the bottom.
+
#### 1. Install the Rust development environment.
See https://www.rust-lang.org/tools/install.
@@ -44,6 +49,13 @@ All git commands that display diff output should now display syntax-highlighted
- `git log -p`
- `git stash show -p`
+#### Tmux 24bit color configuration
+ If you're using tmux, it's worth checking that 24 bit color is working correctly. For example, run a color test script like [this one](https://gist.githubusercontent.com/lifepillar/09a44b8cf0f9397465614e622979107f/raw/24-bit-color.sh), or the others listed at https://gist.github.com/XVilka/8346728. If you do not see smooth color gradients, see the discussion at [tmux#696](https://github.com/tmux/tmux/issues/696). The short version is you need something like this in your `~/.tmux.conf`:
+ ```
+ set -ga terminal-overrides ",xterm-256color:Tc"
+ ```
+ and you may then need to quit tmux completely for it to take effect.
+
## Credit
https://github.com/trishume/syntect<br>
https://github.com/sharkdp/bat