Add installation instructions to README.md

This commit is contained in:
Karl Fogel 2019-06-17 01:14:20 -05:00
parent ef2e4ebf28
commit 2ff8988b3d

View File

@ -100,6 +100,18 @@ The following adapters are disabled by default, and can be enabled using '--rga-
Extensions: .jpg, .png 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: ## USAGE:
> rga \[FLAGS\] \[OPTIONS\] PATTERN \[PATH ...\] > rga \[FLAGS\] \[OPTIONS\] PATTERN \[PATH ...\]