Point freeroute links at public PyPI, fix routing-config defaults
Some checks failed
CI / Lint and Format (push) Has been cancelled
CI / Test Python 3.11 on macos-latest (push) Has been cancelled
CI / Test Python 3.12 on macos-latest (push) Has been cancelled
CI / Test Python 3.13 on macos-latest (push) Has been cancelled
CI / Test Python 3.10 on ubuntu-latest (push) Has been cancelled
CI / Test Python 3.11 on ubuntu-latest (push) Has been cancelled
CI / Test Python 3.12 on ubuntu-latest (push) Has been cancelled
CI / Test Python 3.13 on ubuntu-latest (push) Has been cancelled
CI / Security Scan (push) Has been cancelled
CI / Build Package (push) Has been cancelled

The docs site is public; the freeroute Gitea repo is private, so link the
public PyPI project page instead. Set freeroute_shove/diagonal defaults to
false (their actual mckicad routing_config defaults) rather than
'engine-dependent'.
This commit is contained in:
Ryan Malloy 2026-07-14 22:53:58 -06:00
parent 349616b77d
commit 1cb6ad1a59
6 changed files with 8 additions and 8 deletions

View File

@ -26,7 +26,7 @@ Tools degrade gracefully: if KiCad is not running, IPC-dependent tools report th
**Export and manufacturing** -- Generate Gerber files, drill files, PDFs, and SVGs for your boards. Everything goes through kicad-cli with proper layer selection and output directory organization.
**Autorouting** -- Route PCBs automatically through a fully headless, Java-free pipeline built on [freeroute](https://git.supported.systems/warehack.ing/freeroute) (a native-Python port of the FreeRouting engine), with the FreeRouting JAR available as a fallback for maximum net completion on dense boards.
**Autorouting** -- Route PCBs automatically through a fully headless, Java-free pipeline built on [freeroute](https://pypi.org/project/freeroute/) (a native-Python port of the FreeRouting engine), with the FreeRouting JAR available as a fallback for maximum net completion on dense boards.
**Board analysis** -- Live board statistics, connectivity monitoring, component detail inspection, and routing quality analysis through the IPC API.

View File

@ -39,8 +39,8 @@ Autorouting is configured per call through the `routing_config` argument of `rou
|-----|-------------|---------|
| `freeroute_engine` | Router engine: `room`, `exact`, or `grid` | `room` |
| `freeroute_pack` | Enable channel packing for tighter routing | `true` |
| `freeroute_shove` | Allow shoving existing traces to make room | Engine-dependent |
| `freeroute_diagonal` | Allow 45-degree / diagonal trace shortening | Engine-dependent |
| `freeroute_shove` | Allow shoving existing traces to make room (`room`/`exact` engines) | `false` |
| `freeroute_diagonal` | Allow 45-degree / diagonal trace shortening (`exact` engine) | `false` |
See the [Autorouting guide](/guides/routing/) for what each engine does and when to reach for it.

View File

@ -103,7 +103,7 @@ If the server is running and configured correctly, it will scan your search path
## Optional: autorouting
For automated PCB routing, install [freeroute](https://git.supported.systems/warehack.ing/freeroute), a native-Python, Java-free autorouter:
For automated PCB routing, install [freeroute](https://pypi.org/project/freeroute/), a native-Python, Java-free autorouter:
```bash
uv tool install freeroute

View File

@ -5,12 +5,12 @@ description: "Route PCBs automatically through a headless, Java-free pipeline"
The routing tools take an unrouted (or partially routed) PCB and lay copper for the remaining nets automatically. The whole pipeline is headless and needs no display, no running KiCad GUI, and no Java runtime by default, which makes it usable in CI, containers, and from an MCP client.
Routing runs through [freeroute](https://git.supported.systems/warehack.ing/freeroute), a native-Python port of the FreeRouting engine, with the original FreeRouting JAR available as an optional fallback for dense boards.
Routing runs through [freeroute](https://pypi.org/project/freeroute/), a native-Python port of the FreeRouting engine, with the original FreeRouting JAR available as an optional fallback for dense boards.
## Prerequisites
- KiCad with its bundled `pcbnew` Python module (used for DSN export and the native SES applier)
- [freeroute](https://git.supported.systems/warehack.ing/freeroute) installed and on your PATH:
- [freeroute](https://pypi.org/project/freeroute/) installed and on your PATH:
```bash
uv tool install freeroute

View File

@ -60,7 +60,7 @@ KICAD_APP_PATH=/Applications/KiCad/KiCad.app
### FREEROUTE_CLI
Path to the [freeroute](https://git.supported.systems/warehack.ing/freeroute) CLI, the preferred autorouter. freeroute is a native-Python, Java-free port of the FreeRouting engine.
Path to the [freeroute](https://pypi.org/project/freeroute/) CLI, the preferred autorouter. freeroute is a native-Python, Java-free port of the FreeRouting engine.
```
FREEROUTE_CLI=~/.local/bin/freeroute

View File

@ -155,7 +155,7 @@ See [Autowiring guide](/guides/autowire/) for details on the decision tree.
## Routing tools
`tools/routing.py` -- autorouter integration. Prefers the Java-free [freeroute](https://git.supported.systems/warehack.ing/freeroute) CLI and falls back to the FreeRouting JAR. See the [Autorouting guide](/guides/routing/).
`tools/routing.py` -- autorouter integration. Prefers the Java-free [freeroute](https://pypi.org/project/freeroute/) CLI and falls back to the FreeRouting JAR. See the [Autorouting guide](/guides/routing/).
| Tool | Description |
|------|-------------|