aboutsummaryrefslogtreecommitdiff
path: root/system/ripgrep/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/ripgrep/README')
-rw-r--r--system/ripgrep/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/system/ripgrep/README b/system/ripgrep/README
new file mode 100644
index 0000000000000..18f21fb3a808c
--- /dev/null
+++ b/system/ripgrep/README
@@ -0,0 +1,13 @@
+ripgrep - line oriented search tool
+
+ripgrep is a line oriented search tool that combines the usability of
+The Silver Searcher (similar to ack) with the raw speed of GNU grep.
+
+By default, the slackbuild requires all crate dependencies to be downloaded
+individually. Optionally, if you already have cargo-vendor installed, you can
+create a "vendored" tarball which contains all the crate dependencies exploded
+into a single directory and then compressed together as a tarball.
+
+The script ripgrep-mkvendortarball.sh will generate this for you. The
+slackbuild will automatically use this tarball if found in the current
+directory.