updated readme with basic instructions

This commit is contained in:
2025-12-31 14:32:00 +13:00
parent b9a73e4473
commit ef2f5452c1

View File

@@ -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`