https://github.com/dnschneid/kischvidimer
READ-ONLY MIRROR of GitLab
https://github.com/dnschneid/kischvidimer
eeschema kicad
Last synced: 4 months ago
JSON representation
READ-ONLY MIRROR of GitLab
- Host: GitHub
- URL: https://github.com/dnschneid/kischvidimer
- Owner: dnschneid
- License: apache-2.0
- Created: 2025-02-14T18:35:52.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-14T19:07:34.000Z (4 months ago)
- Last Synced: 2025-02-14T20:20:00.474Z (4 months ago)
- Topics: eeschema, kicad
- Language: Python
- Homepage: https://gitlab.com/dnschneid/kischvidimer
- Size: 4.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# kischvidimer
The KiCad schematic viewer / differ / merger.
(although right now it just views)
## tl;dr
kischvidimer generates a self-contained HTML webapp with your KiCad schematic
embedded. You can view the file locally, send it as an email attachment, or host
it on a webserver.
Give it a test whirl:
```
python3 -m kischvidimer schgen .../your_project.kicad_pro -o your_project.html
```
Or install it:
```
pip3 install .
cd .../your_project
kischvidimer schgen your_project.kicad_pro -o your_project.html
```
Integrate it into your Gitlab CI:
```
include: "https://gitlab.com/dnschneid/kischvidimer/raw/main/ci/gitlab.yml"
```
## What about layout?
Nope. Try [KiCanvas](https://kicanvas.org/) instead?
## OK then why does this exist?
Think of it as a PDF export of your schematic, but way, way better. kischvidimer
is designed to scale well to handle absolutely ginormous schematics, complex
variable usage, and large amounts of hierarchy and reuse.
As an example, exporting a real-life 158-page schematic as a PDF results in a
42MiB file. The HTML file generated by kischvidimer is 1.8MiB (<5%!), includes a
bunch of metadata and navigational aids, and can be viewed with ease on your
phone. You can even hit the print button and generate a massive PDF if you so
desire.
The HTML file has zero external dependencies and will not attempt to communicate
with any server (unless you launch a datasheet, of course), so you really can
treat it just like a PDF.
## KiCad already has SVG output!
It does! And the output is visually perfect! But the files are large, have hacks
of their own around text glyphs, and are difficult to inject metadata into. It
would be nigh impossible to implement the diffing and merging UI with them.
## What's in the works?
* KiCad 9 support
* Netlist intelligence and navigation
* Diffing and merging, of course
## How to pronounce kischvidimer?
Well, KiCad is pronounced KEY-cad, so I guess it should be KEY-schvidimer.