updated readme with basic instructions
This commit is contained in:
23
README.md
23
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
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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`
|
||||||
Reference in New Issue
Block a user