aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 688f822..d02ba32 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,8 @@
# cgrep
`grep` for C/C++ source files.<br/>
-cgrep uses libtooling, the latest tested version of LLVM is trunk 340121.<br/>
Should be more or less fine for other C-family languages as well but I haven't tested for those since I don't use those. Let me know if you run into trouble using cgrep on those.<br/>
+The goal is to make the options and features as similar to `grep` as possible for ease of use.<br/>
## Bulding
Assuming you have the llvm/clang libraries(the build file will read your llvm options using `llvm-config` so make sure it's in path), just run:<br/>
@@ -15,7 +15,7 @@ git submodule init
git submodule update
make
```
-`cgrep` supports LLVM 6,8, and for 9 the latest tested trunk version currently is:355787.<br/>
+`cgrep` supports LLVM 5,6,8,9. For 10. the latest tested trunk version is:367652. support for 5 and 6 might be dropped in the future.<br/>
The makefile assumes clang is called `clang` and llvm-config is called `llvm-config`. On some distros, the names might not be the same. In those cases use `CXX` and `LLVM_CONF` to pass the values to the makefile.<br/>
## Usage
@@ -57,6 +57,14 @@ For an up-to-date list, you can run `crep --help`.<br/>
```
`cgrep` is a clang tool, so it will accecpt all valid clang commandline options.<br/>
+## Known Issues
+* bulding cgrep with `-j` will not work because shitty makefile.<br/>
+* the coloring is off right now and doesn't work properly.<br/>
+=======
## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbloodstalker%2Fcgrep.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbloodstalker%2Fcgrep?ref=badge_large) \ No newline at end of file
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbloodstalker%2Fcgrep.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbloodstalker%2Fcgrep?ref=badge_large)
+=======
+
+## License
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbloodstalker%2Fcgrep.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbloodstalker%2Fcgrep?ref=badge_large)