updated the readme with build instructions

2026-05-13 12:07:26 -05:00
parent 3f0f826f6b
commit 8114b561a1
1 changed files with 13 additions and 0 deletions
@@ -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.