From 50f7a60a8d730266a55717a0e19b978a7ce2c740 Mon Sep 17 00:00:00 2001 From: Jean-Marie Comets Date: Sat, 4 Feb 2017 11:12:36 +0100 Subject: [PATCH] Add "Known issues" section in README.md Also document that ctrl-c doesn't restore the termcolor. Fixes #347. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 82df80e..6827e70 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