kararrr/README.md

73 lines
1.2 KiB
Markdown

# KARARRR
Kicad AutoRouter, ARRR `<make pirate sound>`.
An autorouter kludge for KiCad 6 and Python 3.
![kararrr screenshot](examples/kararrr-pcb.png)
# Installation
HOWTO install.
```
git clone https://spacecruft.org/spacecruft/kararrr
cd kararrr
# Install distro Python Pip, such as on Debian stable (Bullseye/11);
apt update
apt install python3-pip
# Install python deps as you like, such as:
pip3 install --user --upgrade -r requirements.txt
```
# Usage
HOWTO use.
```
# Process netlist with live view.
./pcb.py --v 1 examples/netlist.pcb | ./view.py
# Process netlist, redirect to "anim" file.
./pcb.py --v 1 examples/netlist.pcb > anim
# View "anim" file using aggDraw.
./view.py anim
# View "anim" file using matplotlib
./view_mpl.py anim
```
# Upstream
Based on Python-PCB for Python2 by Chris Hinsley,
released under the GPLv2 license, source code available here:
* https://github.com/vygr/Python-PCB
Other bits from other repos for reading `.dsn` are from here:
* https://github.com/vygr/C-PCB
* https://github.com/vygr/Go-PCB
# Disclaimer
Alpha software, not for use.
This somewhat works standalone now in Python3, but not with KiCad.
# Copyright
GPLv2 license.
Copyright (C) 2014, 2015, Chris Hinsley
Copyright (C) 2022, Jeff Moe