From ef2f5452c169055361fdaf1e3111cd55863a36eb Mon Sep 17 00:00:00 2001
From: sirlilpanda <me@sirlilpanda.studio>
Date: Wed, 31 Dec 2025 14:32:00 +1300
Subject: [PATCH] updated readme with basic instructions

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

diff --git a/README.md b/README.md
index e69de29..1fed5a8 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,23 @@
+# How to use this template
+
+this template will auto:
+    - run erc checks
+    - run drc checks
+    - create schematic pdfs
+    - create BOM for each project
+    - create images of the current pcb for your readme like you can see below
+
+![rendered pcb](res/test_render.png)
+
+the code for creating all of this lives in `.hooks/`
+
+## setup
+dependencies:
+    - python3.9+   (used for crossplatfrom scripting)
+    - kicad-cli 
+
+to set up the hooks just run
+```
+python setup.py
+```
+This script will add a line in the `.git/hooks/pre-push` to auto run `.hooks/kicad_cli_tools.py`
\ No newline at end of file