From 8114b561a1b58cee29847c28628771d5f6491295 Mon Sep 17 00:00:00 2001
From: pyro <kevin.gunter@rocketweasle.site>
Date: Wed, 13 May 2026 12:07:26 -0500
Subject: [PATCH] updated the readme with build instructions

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

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.