https://github.com/yaqwsx/PcbDraw

Convert your KiCAD board into a nicely looking 2D drawing suitable for pinout diagrams
https://github.com/yaqwsx/PcbDraw

kicad pcb pcb-diagram

Last synced: about 2 months ago
JSON representation

Convert your KiCAD board into a nicely looking 2D drawing suitable for pinout diagrams

• Host: GitHub
• URL: https://github.com/yaqwsx/PcbDraw
• Owner: yaqwsx
• License: mit
• Created: 2017-04-13T08:17:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-03T06:07:46.000Z (5 months ago)
• Last Synced: 2024-07-24T06:31:45.400Z (about 2 months ago)
• Topics: kicad, pcb, pcb-diagram
• Language: Python
• Homepage:
• Size: 1.8 MB
• Stars: 1,108
• Watchers: 29
• Forks: 88
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-robotic-tooling - PcbDraw - Convert your KiCAD board into a nice looking 2D drawing suitable for pinout diagrams. (Electronics and Mechanics / Version Control)
• awesome-robotic-tooling - PcbDraw - Convert your KiCAD board into a nice looking 2D drawing suitable for pinout diagrams (Hardware / Version Control)
• awesome-opensource-hardware - pcbdraw

README

        
# PcbDraw

Convert your KiCAD boards into nice looking 2D drawings suitable for pinout

diagrams. Never draw them manually again!

![example](promo_pcbdraw.png)

This tool takes a KiCAD board (.kicad_pcb file) and produces a 2D

nice looking drawing of the board as an SVG file. This allows you to quickly and

automatically create awesome pinout diagrams for your project. These diagrams

are much easier to read than a labeled photo of a physical board or an actual

KiCAD design.

You and your users will love them!

PcbDraw also comes with a small utility called Populate which allows you to

easily specify & maintain nice looking HTML or Markdown population manuals.

![example](promo_populate.jpg)

And, also, as a bonus it allows you to programmatically obtain 3D-rendered

previews of your boards (e.g., in CI).

## Installation

PcbDraw is a stand-alone CLI tool distributed as a Python package `pcbdraw`. It

also requires Inkscape 1 or librsvg installed. Read more details in the

[installation guide](doc/installation.md).

## Usage

There are two separate guides:

- [usage of PcbDraw](doc/pcbdraw.md)

- [usage of Populate](doc/populate.md)

- [library management tools](doc/library.md)

There are also examples of usage in the `examples` directory.

## PcbDraw seems to be broken!

Please, read [FAQ](doc/faq.md) first. If it does not answer your problem, feel

free to open issue on GitHub.

## Contributing

Feel free to submit issues and pull requests!

## Future Work

- make reasonably complete module library