From 450f913fc6b2ed5a7121608349875b0dafa915f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andre=20Schr=C3=B6der?= Date: Sun, 5 Jan 2020 16:01:21 +0100 Subject: Fix spelling --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 34bdcc7..64963b5 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Should be more or less fine for other C-family languages as well but I haven't t The goal is to make the options and features as similar to `grep` as possible for ease of use.
## Building -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:
+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:
```bash git clone https://github.com/bloodstalker/cgrep cd cgrep @@ -25,29 +25,29 @@ git submodule update make ``` If you have installed LLVM but don't have `llvm-config`, you are missing the dev package for LLVM.
-`cgrep` supports LLVM 5,6,7,8 and 9. For 10. the latest tested trunk version is:374971.
+`cgrep` supports LLVM 5,6,7,8 and 9. For 10 the latest tested trunk version is: 374971.
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 like so:
```bash make CXX=clang-9.0 LLVM_CONF=llvm-config-9.0 ``` -For windows builds, cygwin builds are supported. get llvm and clang along with their sources and build like usual.
+For windows builds, cygwin builds are supported. Get llvm and clang along with their sources and build like usual.
## Usage A simple usage example:
```bash cgrep -A 1 -B 1 --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 `\\`.
+Please 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 command line 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) or [scan-build](https://github.com/rizsotto/scan-build).
-You can also skip the compilation database alltogether passing cgrep `--` after the input file name which means you have chosen not to pass it anything.
+You can also skip the compilation database altogether passing cgrep `--` after the input file name which means you have chosen not to pass it anything.
You can pass the options by hand since cgrep is a Clang instance so it recognizes every option clang has.
cgrep uses ANSI escape sequences for colors so your terminal should support those.
## Options -Here's an option list though it might not be necessarily up-to-date.
-For an up-to-date list, you can run `crep --help`.
+Here's an option list, though it might not be necessarily up-to-date.
+For an up-to-date list, you can run `cgrep --help`.
```bash -A= - same as grep, how many lines after the matched line to print @@ -75,10 +75,10 @@ For an up-to-date list, you can run `crep --help`.
--union - match unions only --var - match variables only ``` -`cgrep` is a clang tool, so it will accecpt all valid clang commandline options.
+`cgrep` is a clang tool, so it will accept all valid clang command line options.
## Known Issues -* bulding cgrep with `-j` will not work because bad makefile.
+* building cgrep with `-j` will not work because bad makefile.
* the coloring is off right now and doesn't work properly.
======= -- cgit v1.2.3