From 18d3f593f55e60af96b3083999aee62842ef5f6d Mon Sep 17 00:00:00 2001 From: bloodstalker Date: Mon, 12 Nov 2018 18:59:15 +0330 Subject: update --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5fd02a8..10ee8ce 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,9 @@ A simple usage example:
cgrep --func --var --regex n[aA]m ./cgrep.cpp ``` Pleade do note that the regex will pass through both C++ and the regex engine, so if you would want to escape `\`, the regex you pass as the commandline arg would be `\\\\` instead of the normal `\\`.
+In order for cgrep to work, you need to have a compilation database, tools like cmake can generate one for you.
+If your build tool doesn't do that, you can just use [bear](https://github.com/rizsotto/Bear).
+You can also skipp the compilation database alltogether passing cgrep `--` after the input file name.
## Options Here's an option list though it might not be necessarily up-to-date.
-- cgit v1.2.3