From 986e4bd7b42966f6a528ab1f34d234c54808b0dd Mon Sep 17 00:00:00 2001 From: "Morgan 'ARR\\!' Allen" Date: Fri, 28 Mar 2025 22:36:38 -0700 Subject: [PATCH] README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b03705 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# KiConnect + +KiCAD 9 API Workbench + +## What works +* Create board +* Add Vias +* Add footprint pads +* Import footprint 3d models +* Reload outline after changed in KiCAD +* Can be used in FreeCAD Assemblies + +## In Progress / To be ported + +### Tracks +Tracks can be loaded and drawn as simple `LineSegment` but more work is needed to draw properly 'widthed', and particularly whilte trying to eliminate overlapping lines. + +### More Pad Shapes +Only rectangle get drawn right now, would like to figure out how to get Sketcher to do the heavy lifting + +### Sync to KiCAD +In theory this code is mostly working but there seems to be an [issue in kicad-python](https://gitlab.com/kicad/code/kicad-python/-/issues/34) + +## Plans + +### Add more board features +Currently refactoring similar objects to common base class, this will enable easily including other board elements (text, graphics, ) + +### Package as proper FreeCAD add-on + +### Mutliboard support +Hope to support this one of several ways, depending on the future of KiCAD/API +* KiCAD supports multi-document, API include `get_boards()` +* `kicad-cli` supports full API, spin up instances as needed +* Manually switch between KiCAD projects and import new boards +* socker-per-project but this seems messy + +### Panelization +In it's most basic form, this will probably utilize `kikit` to assist in basic panelization but in multiboard projects it will assist in panelizing differnt boards into one panel. + +### Syncronize all the things! +Syncing selections is fairly straight forward, but long term it would be awesome to have everything sync as their changed.