diff options
author | Christoph Michelbach <michelbach94@gmail.com> | 2017-10-31 22:17:35 +0100 |
---|---|---|
committer | Andrew Gallant <jamslam@gmail.com> | 2017-11-01 07:09:34 -0400 |
commit | c4732ca0123488455b1720359bdb26c8af439a96 (patch) | |
tree | 7f7c76cfceeb8fa168005d429c273d0abb1ed1da /README.md | |
parent | 1aec4b11231ccb7de92e3008408e4d06a714d106 (diff) |
Correct spelling mistakes in readme file.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -1,6 +1,6 @@ ripgrep (rg) ------------ -`ripgrep` is a line oriented search tool that recursively searches your current +`ripgrep` is a line-oriented search tool that recursively searches your current directory for a regex pattern while respecting your gitignore rules. To a first approximation, ripgrep combines the usability of The Silver Searcher (similar to `ack`) with the raw speed of GNU grep. `ripgrep` has first class support on @@ -47,7 +47,7 @@ for a very detailed comparison with more benchmarks and analysis. Here's another benchmark that disregards gitignore files and searches with a whitelist instead. The corpus is the same as in the previous benchmark, and the -flags passed to each command ensures that they are doing equivalent work: +flags passed to each command ensure that they are doing equivalent work: | Tool | Command | Line count | Time | | ---- | ------- | ---------- | ---- | @@ -57,7 +57,7 @@ flags passed to each command ensures that they are doing equivalent work: (`ucg` [has slightly different behavior in the presence of symbolic links](https://github.com/gvansickle/ucg/issues/106).) -And finally, a straight up comparison between ripgrep and GNU grep on a single +And finally, a straight-up comparison between ripgrep and GNU grep on a single large file (~9.3GB, [`OpenSubtitles2016.raw.en.gz`](http://opus.lingfil.uu.se/OpenSubtitles2016/mono/OpenSubtitles2016.raw.en.gz)): @@ -77,7 +77,7 @@ increases the times to `3.081s` for ripgrep and `11.403s` for GNU grep. * Like The Silver Searcher, `ripgrep` defaults to recursive directory search and won't search files ignored by your `.gitignore` files. It also ignores hidden and binary files by default. `ripgrep` also implements full support - for `.gitignore`, where as there are many bugs related to that functionality + for `.gitignore`, whereas there are many bugs related to that functionality in The Silver Searcher. * `ripgrep` can search specific types of files. For example, `rg -tpy foo` limits your search to Python files and `rg -Tjs foo` excludes Javascript @@ -93,7 +93,7 @@ increases the times to `3.081s` for ripgrep and `11.403s` for GNU grep. specifically specified with the `-E/--encoding` flag.) In other words, use `ripgrep` if you like speed, filtering by default, fewer -bugs and Unicode support. +bugs, and Unicode support. ### Why shouldn't I use `ripgrep`? @@ -102,7 +102,7 @@ give you a glimpse at some important downsides or missing features of `ripgrep`. * `ripgrep` uses a regex engine based on finite automata, so if you want fancy - regex features such as backreferences or look around, `ripgrep` won't give + regex features such as backreferences or lookaround, `ripgrep` won't provide them to you. `ripgrep` does support lots of things though, including, but not limited to: lazy quantification (e.g., `a+?`), repetitions (e.g., `a{2,5}`), begin/end assertions (e.g., `^\w+$`), word boundaries (e.g., `\bfoo\b`), and @@ -229,7 +229,7 @@ $ cargo install ripgrep ### Whirlwind tour -The command line usage of `ripgrep` doesn't differ much from other tools that +The command-line usage of `ripgrep` doesn't differ much from other tools that perform a similar function, so you probably already know how to use `ripgrep`. The full details can be found in `rg --help`, but let's go on a whirlwind tour. @@ -239,7 +239,7 @@ Coloring works on Windows too! Colors can be controlled more granularly with the `--color` flag. One last thing before we get started: generally speaking, `ripgrep` assumes the -input is reading is UTF-8. However, if ripgrep notices a file is encoded as +input it is reading to be UTF-8. However, if ripgrep notices a file is encoded as UTF-16, then it will know how to search it. For other encodings, you'll need to explicitly specify them with the `-E/--encoding` flag. @@ -384,7 +384,7 @@ If your machine doesn't support AVX instructions, then simply remove ### Running tests -`ripgrep` is relatively well tested, including both unit tests and integration +`ripgrep` is relatively well-tested, including both unit tests and integration tests. To run the full test suite, use: ``` @@ -399,8 +399,8 @@ from the repository root. ##### Powershell Profile -To customize powershell on start-up there is a special powershell script that has to be created. -In order to find its location type `$profile` +To customize powershell on start-up, there is a special powershell script that has to be created. +In order to find its location, type `$profile` See [more](https://technet.microsoft.com/en-us/library/bb613488(v=vs.85).aspx) for profile details. Any powershell code in this file gets evaluated at the start of console. |