diff --git a/README.md b/README.md index a9ae3e2..58f885e 100644 --- a/README.md +++ b/README.md @@ -50,3 +50,16 @@ find PDFs for google and save to a markdwon file: find PDFs for google and save to both a CSV and Markdown file: `ferrisfind -k {serpapi key} -n google -c ./metadata.csv -m ./metadata.md` + +# Building +clone this repo: + +`git clone https://git.pyro.monster/pyro/ferrisfind.git` + +cd into the repo and build with cargo: + +`cd ferrisfind` + +`cargo build --release` + +Your compiled binary will be in ferrisfind/target/release/ferrisfind.