summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJean-Marie Comets <jmcomets@users.noreply.github.com>2017-02-04 11:12:36 +0100
committerAndrew Gallant <jamslam@gmail.com>2017-03-08 10:18:19 -0500
commit50f7a60a8d730266a55717a0e19b978a7ce2c740 (patch)
tree25907d2ed0ef3d7f638df5d3cf1c81b7d7dcd9df /README.md
parent33ec988d7068e0d7a6d6504bcf3a06056344e887 (diff)
Add "Known issues" section in README.md
Also document that ctrl-c doesn't restore the termcolor. Fixes #347.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 82df80ef..6827e703 100644
--- a/README.md
+++ b/README.md
@@ -376,3 +376,17 @@ $ cargo test
```
from the repository root.
+
+### Known issues
+
+#### I just hit Ctrl+C in the middle of ripgrep's output and now my terminal's foreground color is wrong!
+
+Type in `color` on Windows and `echo -ne "\033[0m"` on Unix to restore your
+original foreground color.
+
+PR [#187](https://github.com/BurntSushi/ripgrep/pull/187) fixed this, and it
+was later deprecated in
+[#281](https://github.com/BurntSushi/ripgrep/issues/281). A full explanation is
+available [here][msys issue explanation].
+
+[msys issue explanation]: https://github.com/BurntSushi/ripgrep/issues/281#issuecomment-269093893