From 2ff8988b3d2f92582ab2ae2418f8755b8916ce70 Mon Sep 17 00:00:00 2001 From: Karl Fogel Date: Mon, 17 Jun 2019 01:14:20 -0500 Subject: [PATCH] Add installation instructions to README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d56ada2..3ff87c2 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,18 @@ The following adapters are disabled by default, and can be enabled using '--rga- Extensions: .jpg, .png +## INSTALLATION: + +rga should compile with stable Rust. To build it, run the following (or the equivalent in your OS): + +``` + ~$ apt install build-essential pandoc poppler-utils ffmpeg ripgrep cargo + ~$ cargo install ripgrep_all + ~$ rga --version # this should work now +``` + +You could do `cargo build`, instead of `cargo install ripgrep_all`, to just build rga in the local tree. + ## USAGE: > rga \[FLAGS\] \[OPTIONS\] PATTERN \[PATH ...\]