summaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
2018-08-20ripgrep: migrate to libripgrepAndrew Gallant
This commit does the work to delete the old `grep` crate and effectively rewrite most of ripgrep core to use the new libripgrep crates. The new `grep` crate is now a facade that collects the various crates that make up libripgrep. The most complex part of ripgrep core is now arguably the translation between command line parameters and the library options, which is ultimately where we want to be.
2018-08-17readme: ripgrep is available in Debian BusterSylvestre Ledru
PR #1016
2018-08-07readme: update debian link to 0.9.0Jonatan Hamberg
PR #1006
2018-07-21ripgrep: add --pre flagCharles Blake
The preprocessor flag accepts a command program and executes this program for every input file that is searched. Instead of searching the file directly, ripgrep will instead search the stdout contents of the program. Closes #978, Closes #981
2018-07-21ripgrep: add support for lz4 decompressionKalle Samuels
This uses the lz4 binary for decompression. Closes #898
2018-07-17readme: update rogue 1.20 referenceAndrew Gallant
2018-07-17deps: bump minimum Rust to 1.23.0 from 1.20.0Andrew Gallant
1.23.0 is the first Rust release of 2018 and is around half a year old, which seems old enough to move to. This also lets us bring in encoding_rs 0.8, which includes performance optimizations.
2018-06-21deps: update to regex 1.0.1Andrew Gallant
This causes SIMD to kick in automatically when compiling with stable Rust 1.27+. We also update the README to describe the current state of things. Thanks to @hartley for pointing this out: https://twitter.com/hartley/status/1009950392862453760
2018-05-24doc: add MacPorts installation instructionsGeorge Plymale II
2018-05-24doc: update crates.io badgeKhalid Jebbari
This is the official markdown snippet from shields.io
2018-05-14doc: add BSD packages to READMEWesley Moore
2018-05-08doc: fix broken link to RegexSet docsMichael Hay
2018-04-30doc: go away snapAndrew Gallant
Snap has caused a number of nonsensical bug reports, and not even the `--classic` flag seems capable of fixing them. Therefore, remove snap from the README and put in a special line in the ISSUE_TEMPLATE about snap. FIxes #902
2018-04-17readme: add --classic flag to snap installAndrew Gallant
It would be nicer to switch to the `ripgrep` snap package, but apparently it is configured to install with a binary name `ripgrep.rg` instead of just `rg`. *sigh*
2018-04-09readme: add openSUSE Tumbleweed packageAvindra Goolcharan
Link to software.opensuse.org package and add `zypper` instructions.
2018-03-12deps: update regex crateAndrew Gallant
This update brings with it a new feature of the regex crate which will now use SIMD optimizations automatically at runtime with no necessary compile time flags. All that's needed is to enable the `unstable` feature. Other crates, such as bytecount and encoding_rs, are still using the old-style SIMD support, so we leave the simd-accel and avx-accel features. However, the binaries we distribute on Github no longer have those features enabled, which makes them truly portable. Fixes #135
2018-03-10doc: add Windows Scoop install instructionsAlejandro Barreto
2018-03-09doc: add additional instructions for snapRyan Hayle
In the snap store, ripgrep 0.8.1 is only available as a candidate release, while the default (stable) release is 0.7.1.
2018-03-07doc: shorten Rust nightly brew install commandPatrick Artounian
The burntsushi/ripgrep/ prefix is not needed.
2018-02-22doc: clarify snap installation instructionsAndrew Gallant
Fixes #782
2018-02-20release: 0.8.1Andrew Gallant
2018-02-20doc: clarify Debian/Ubuntu install instructionsAndrew Gallant
Thanks @x4121 for the tip!
2018-02-20doc: fix typo in Debian install instructionsDavid Peter
2018-02-18doc: add .deb installation instructionsAndrew Gallant
Generating a Debian binary package was pretty easy using `cargo deb`, so it is now part of the release. This commit updates the README's installation methods to reference it. I did look into setting up a PPA for Ubuntu, but my eyes glazed over while reading the documentation. Providing a binary Debian package is likely a faux pas, but it is extraordinarily convenient.
2018-02-12doc: add "grep replacement" question to FAQAndrew Gallant
I am tired of being throwing "but ripgrep is marketed as a grep replacement" in my face. Let's answer it once and for all.
2018-02-10doc: overhaul documentationAndrew Gallant
This commit cleans up the README and splits portions of it out into a user guide (GUIDE.md) and a FAQ (FAQ.md). The README now provides a small list of documentation "quick" links to various parts of the docs. This commit also does a few other minor touchups.
2018-02-04config: add persistent configurationAndrew Gallant
This commit adds support for reading configuration files that change ripgrep's default behavior. The format of the configuration file is an "rc" style and is very simple. It is defined by two rules: 1. Every line is a shell argument, after trimming ASCII whitespace. 2. Lines starting with '#' (optionally preceded by any amount of ASCII whitespace) are ignored. ripgrep will look for a single configuration file if and only if the RIPGREP_CONFIG_PATH environment variable is set and is non-empty. ripgrep will parse shell arguments from this file on startup and will behave as if the arguments in this file were prepended to any explicit arguments given to ripgrep on the command line. For example, if your ripgreprc file contained a single line: --smart-case then the following command RIPGREP_CONFIG_PATH=wherever/.ripgreprc rg foo would behave identically to the following command rg --smart-case foo This commit also adds a new flag, --no-config, that when present will suppress any and all support for configuration. This includes any future support for auto-loading configuration files from pre-determined paths (which this commit does not add). Conflicts between configuration files and explicit arguments are handled exactly like conflicts in the same command line invocation. That is, this command: RIPGREP_CONFIG_PATH=wherever/.ripgreprc rg foo --case-sensitive is exactly equivalent to rg --smart-case foo --case-sensitive in which case, the --case-sensitive flag would override the --smart-case flag. Closes #196
2018-01-30search: add support for searching compressed filesBalaji Sivaraman
This commit adds opt-in support for searching compressed files during recursive search. This behavior is only enabled when the `-z/--search-zip` flag is passed to ripgrep. When enabled, a limited set of common compression formats are recognized via file extension, and a new process is spawned to perform the decompression. ripgrep then searches the stdout of that spawned process. Closes #539
2018-01-12readme: add Ubuntu install instructionsSebastian Torres
2018-01-12readme: ripgrep is in Fedora 27Igor Gnatenko
References: https://bodhi.fedoraproject.org/updates/FEDORA-2018-ca3c304458
2018-01-08readme: update summary benchmarksAndrew Gallant
2018-01-08readme: link to Andy Lester's feature comparisonAndrew Gallant
2018-01-07remove reference to copr for F28+Igor Gnatenko
Signed-off-by: Igor Gnatenko <i.gnatenko.brain@gmail.com>
2018-01-07trivial: update instructions for FedoraIgor Gnatenko
Signed-off-by: Igor Gnatenko <i.gnatenko.brain@gmail.com>
2017-11-22full package name for Gentoo sys-apps/ripgrepJonas Stein
2017-11-03Added example for --colors to READMEReuben D'Netto
2017-11-01Correct spelling mistakes in readme file.Christoph Michelbach
2017-10-14Fix minor typosTJ Rana
Update name Mac OS X to macOS
2017-10-12Add troubleshooting notes re: conflicting tools/aliasesdana
2017-10-10readme: clarify introAndrew Gallant
2017-10-08Addressed code reivew.Omer Katz
2017-10-08Ripgrep installs from Linuxbrew just fine and works as expected.Omer Katz
Mentioned it in the README file :)
2017-10-08Update README to be more explicit about precompiled binaries (fixes #618)dana
2017-10-08Rewording READMEDaniel Vergeylen
Trial to stay consistent with rest of the text. Rewording by native english.
2017-10-08Update READMEDaniel Vergeylen
Notify user `cargo install ripgrep` contains debug symbols and informs how to stripe them.
2017-09-04tweak workingAndrew Gallant
2017-08-23readme: update minimum versionAndrew Gallant
2017-07-22fix profile showing command for powershellLeonardo Santagada
change the profile showing command to one that matches the microsoft article linked, as its simpler and the old one didn't work at least on windows 10 creators edition.
2017-07-08update COPR nameCarl George
I switched Fedora usernames, so new builds will be at a different URL.
2017-05-29Add Zsh completion fileFangrui Song