summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTim Oram <dev@mitmaro.ca>2019-12-08 14:47:17 -0330
committerTim Oram <dev@mitmaro.ca>2019-12-08 17:52:18 -0330
commit6f7b4682ab979df1f3394a3f6eaad7e85e6ce299 (patch)
tree59243130e8974c4ac3a6809c88de46d7da8a4063 /README.md
parent1426a011d1fdd81c4c332876d5ec08e9ef9c5ddd (diff)
Add some notes to the README for Window's users
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1eea458..a4b3d0a 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,21 @@ Git 1.7.8+. Written in Rust using ncurses.
### Windows
- git config --global sequence.editor "'C:/path/to/interactive-rebase-tool'"
+#### Standard Command Pompt
+
+ git config --global sequence.editor "'C:/path/to/interactive-rebase-tool.exe'"
+
+#### GitBash
+
+GitBash requires the use of `winpty` in order to work correctly, so to set the editor use:
+
+ git config --global sequence.editor "winpty /c/path/to/interactive-rebase-tool.exe"
+
+#### Notes
+
+Windows before version 10 has [serious rendering issues with saturated darker colors](https://devblogs.microsoft.com/commandline/updating-the-windows-console-colors/),
+such as the blue color, that are completely illegible on modern displays. While it is possible to avoid using the
+saturated colors, a better option is to update the theme using Microsoft's [ColorTool](https://github.com/Microsoft/Terminal/tree/master/src/tools/ColorTool).
## Usage