summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2018-06-21 20:10:53 -0400
committerAndrew Gallant <jamslam@gmail.com>2018-06-21 20:14:23 -0400
commit5e85f2577baf050cb6b8f8b186b1be28d6ab385e (patch)
treecfa24fbd2a031e55031f332a00324df6d5f65f92 /README.md
parentca23a170f769f59e5bde02a4ab32b54cd2d66165 (diff)
deps: update to regex 1.0.1
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
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index efc41683..eff247a7 100644
--- a/README.md
+++ b/README.md
@@ -306,13 +306,8 @@ If you're a **Rust programmer**, ripgrep can be installed with `cargo`.
$ cargo install ripgrep
```
-If you're using Rust nightly, then use
-
-```
-$ cargo install ripgrep --features unstable
-```
-
-to get SIMD optimizations.
+When compiling with Rust 1.27 or newer, this will automatically enable SIMD
+optimizations for search.
ripgrep isn't currently in any other package repositories.
[I'd like to change that](https://github.com/BurntSushi/ripgrep/issues/10).
@@ -333,7 +328,7 @@ $ ./target/release/rg --version
```
If you have a Rust nightly compiler and a recent Intel CPU, then you can enable
-optional SIMD acceleration like so:
+additional optional SIMD acceleration like so:
```
RUSTFLAGS="-C target-cpu=native" cargo build --release --features 'simd-accel avx-accel'
@@ -343,6 +338,12 @@ If your machine doesn't support AVX instructions, then simply remove
`avx-accel` from the features list. Similarly for SIMD (which corresponds
roughly to SSE instructions).
+The `simd-accel` and `avx-accel` features enable SIMD support in certain
+ripgrep dependencies (responsible for counting lines and transcoding). They
+are not necessary to get SIMD optimizations for search; those are enabled
+automatically. Hopefully, some day, the `simd-accel` and `avx-accel` features
+will similarly become unnecessary.
+
### Running tests