summaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
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
2017-05-08Add Powershell tips and autocompletion instructionsEli Miller
2017-04-09Add short note on Windows TipsDouman
2017-03-14Update whirlwind tour with encoding info.Andrew Gallant
Fixes #1
2017-03-12fix CHANGELOG linkAndrew Gallant
2017-03-12changelog 0.5.0Andrew Gallant
2017-03-12Add support for additional text encodings.Andrew Gallant
This includes, but is not limited to, UTF-16, latin-1, GBK, EUC-JP and Shift_JIS. (Courtesy of the `encoding_rs` crate.) Specifically, this feature enables ripgrep to search files that are encoded in an encoding other than UTF-8. The list of available encodings is tied directly to what the `encoding_rs` crate supports, which is in turn tied to the Encoding Standard. The full list of available encodings can be found here: https://encoding.spec.whatwg.org/#concept-encoding-get This pull request also introduces the notion that text encodings can be automatically detected on a best effort basis. Currently, the only support for this is checking for a UTF-16 bom. In all other cases, a text encoding of `auto` (the default) implies a UTF-8 or ASCII compatible source encoding. When a text encoding is otherwise specified, it is unconditionally used for all files searched. Since ripgrep's regex engine is fundamentally built on top of UTF-8, this feature works by transcoding the files to be searched from their source encoding to UTF-8. This transcoding only happens when: 1. `auto` is specified and a non-UTF-8 encoding is detected. 2. A specific encoding is given by end users (including UTF-8). When transcoding occurs, errors are handled by automatically inserting the Unicode replacement character. In this case, ripgrep's output is guaranteed to be valid UTF-8 (excluding non-UTF-8 file paths, if they are printed). In all other cases, the source text is searched directly, which implies an assumption that it is at least ASCII compatible, but where UTF-8 is most useful. In this scenario, encoding errors are not detected. In this case, ripgrep's output will match the input exactly, byte-for-byte. This design may not be optimal in all cases, but it has some advantages: 1. In the happy path ("UTF-8 everywhere") remains happy. I have not been able to witness any performance regressions. 2. In the non-UTF-8 path, implementation complexity is kept relatively low. The cost here is transcoding itself. A potentially superior implementation might build decoding of any encoding into the regex engine itself. In particular, the fundamental problem with transcoding everything first is that literal optimizations are nearly negated. Future work should entail improving the user experience. For example, we might want to auto-detect more text encodings. A more elaborate UX experience might permit end users to specify multiple text encodings, although this seems hard to pull off in an ergonomic way. Fixes #1
2017-03-08Add "Known issues" section in README.mdJean-Marie Comets
Also document that ctrl-c doesn't restore the termcolor. Fixes #347.
2017-03-01Added Chocolatey to the installation listDavid Salter
2017-02-24kick travisAndrew Gallant
2017-01-14note minimum Rust versionAndrew Gallant
2017-01-09fix minimum Rust versionAndrew Gallant
2017-01-09remove redundant wordsAndrew Gallant
2017-01-09add anti-pitchAndrew Gallant
2017-01-06Add docs for shell completion files.Andrew Gallant
Add small howtos for installing shell completion files to the README and the man page. They are still incomplete. We're missing Zsh and PowerShell. Fixes #262
2016-12-22Update docs to explain use of -g and --files to search for paths. (#285)YPCrumble
Update docs to explain use of -g and --files to search for paths. Fixes #284
2016-12-12Make backreference support clear.Andrew Gallant
Fixes #268.
2016-11-06ucg author says it's not a bug per seAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06typoAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06Update README with more/updated benchmarksAndrew Gallant
2016-11-01Add Gentoo info to the READMETim Harder
2016-10-26Mention Nix package in READMEc74d
In the `README.md` document, where said document documents the availability of pre-built packages of ripgrep, document the availability of such a package from the package management system Nix.
2016-10-22Use svg for travis badgeSimen Bekkhus
2016-10-16Add instructions for installation on Fedora 24+ and RHEL/CentOS 7.Carl George
Please note that the referenced copr repository should just be a temporary home while the Fedora/EPEL package review is pending. https://bugzilla.redhat.com/show_bug.cgi?id=1380442
2016-10-09Update Homebrew instructions in the READMEColin Kennedy
2016-10-05Change Arch Linux instructionsPanashe Fundira
The `-Syu` flag will do a full system upgrade and then install the package, which is not necessarily the desired behavior. Only the `-S` flag is necessary to install a single package. See https://wiki.archlinux.org/index.php/Pacman#Installing_specific_packages https://wiki.archlinux.org/index.php/Pacman#Upgrading_packages
2016-10-03Fix brew formula name to not conflict with coreColin Kennedy
Since the homebrew-core formula was accepted, we should differentiate the prebuilt formula available in this tap
2016-10-03Merge pull request #139 from moshen/make-a-tapAndrew Gallant
Make the repo a Homebrew Tap
2016-09-30Make the repo a Homebrew TapColin Kennedy
2016-09-28clarifyAndrew Gallant
2016-09-27Correct example with --type-add.Andrew Gallant
Fixes #118.
2016-09-26fix use of --type-addAndrew Gallant
2016-09-26ripgrep is now in [community]Sven-Hendrik Haase
The README should reflect that.