Installation and Usage stubs

main
jebba 2022-01-15 00:36:12 -07:00
parent 6d1199ea67
commit a89c0a8e5c
1 changed files with 33 additions and 0 deletions

View File

@ -5,6 +5,39 @@ Kicad AutoRouter, ARRR `<make pirate sound>`.
An autorouter kludge for KiCad 6 and Python 3.
# Installation
HOWTO install.
N.B. This doesn't actually work.
```
git clone https://spacecruft.org/spacecruft/kararrr
cd kararrr
# Install python deps as you like, such as:
pip3 install --user -r requirements.txt
```
# Usage
HOWTO use.
```
# Process netlist with live view.
python3 pcb.py --v 1 netlist.pcb | python3 view.py
# Process netlist, redirect to "anim" file.
python3 pcb.py --v 1 netlist.pcb > anim
# View "anim" file using aggDraw.
python3 view.py anim
# View "anim" file using matplotlib
python3 view_mpl.py anim
```
# Upstream
Based on Python-PCB for Python2 by Chris Hinsley,
released under the GPLv2 license, source code available here: