aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorbloodstalker <thabogre@gmail.com>2018-11-12 15:29:15 +0000
committerbloodstalker <thabogre@gmail.com>2018-11-12 15:29:15 +0000
commit18d3f593f55e60af96b3083999aee62842ef5f6d (patch)
tree2c26e63e506bddc103bae437a8290a5fd7f156e1 /README.md
parentupdate (diff)
downloadcgrep-18d3f593f55e60af96b3083999aee62842ef5f6d.tar.gz
cgrep-18d3f593f55e60af96b3083999aee62842ef5f6d.zip
update
Diffstat (limited to '')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
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:<br/>
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 `\\`.<br/>
+In order for cgrep to work, you need to have a compilation database, tools like cmake can generate one for you.<br/>
+If your build tool doesn't do that, you can just use [bear](https://github.com/rizsotto/Bear).<br/>
+You can also skipp the compilation database alltogether passing cgrep `--` after the input file name.<br/>
## Options
Here's an option list though it might not be necessarily up-to-date.<br/>