Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
qu1ck committed Apr 18, 2019
1 parent 554cf76 commit afa94ee
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# Interactive HTML BOM plugin for KiCad
![icon](https://i.imgur.com/js4kDOn.png)

This plugin was born from necessity of generating convenient BOM listing with ability to easily search for components and their placements on the pcb.
This plugin generates convenient BOM listing with ability to visually correlate
and easily search for components and their placements on the pcb.

This is really useful when hand soldering your prototype and you have to find the 50 places where that 0.1uF cap should be or which of these SOP8 footprints are for the same micro. Dynamically highlighting all components in the same group on the rendering of the pcb makes manually populating the board so much easier.
This is really useful when hand soldering your prototype and you have to find 50
places where 0.1uF cap should be or which of the SOP8 footprints are for the same
micro. Dynamically highlighting all components in the same group on the rendering
of the pcb makes manually populating the board much easier.

This plugin utilizes Pcbnew python bindings to read pcb data and render silkscreen, footprint pads, text and drawings. Additionally it can pull data from schematic if you export it through netlist file or through xml file that Eeschema can generate from it's internal bom tool. That extra data can be added as additional columns in the BOM table (for example manufacturer id) or it can be used to indicate which components should be omitted altogether (dnp field). For full description of functionality see wiki.
This plugin utilizes Pcbnew python bindings to read pcb data and render
silkscreen, fab layer, footprint pads, text and drawings. Additionally it can
pull data from schematic if you export it through netlist or xml file that
Eeschema can generate from it's internal bom tool. That extra data can be added
as additional columns in the BOM table (for example manufacturer id) or it can be
used to indicate which components should be omitted altogether (dnp field). For
full description of functionality see [wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki).

Generated html page is fully self contained, doesn't need internet connection to work and can be packaged with documentation of your project or hosted anywhere on the web.

Expand All @@ -18,8 +29,9 @@ See [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki)

Plugin code is licensed under MIT license, see `LICENSE` for more info.

Html page uses [Split.js](https://github.com/nathancahill/Split.js) library
(also distributed under MIT license) which is embedded into the page.
Html page uses [Split.js](https://github.com/nathancahill/Split.js)
and [PEP.js](https://github.com/jquery/PEP) libraries that get embedded into
generated bom page.

`units.py` is borrowed from [KiBom](https://github.com/SchrodingersGat/KiBoM)
plugin (MIT license).
Binary file added icons/plugin_icon_big.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit afa94ee

Please sign in to comment.