Skip to content

Commit afa94ee

Browse files
committed
Update readme
1 parent 554cf76 commit afa94ee

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
# Interactive HTML BOM plugin for KiCad
2+
![icon](https://i.imgur.com/js4kDOn.png)
23

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

5-
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.
7+
This is really useful when hand soldering your prototype and you have to find 50
8+
places where 0.1uF cap should be or which of the SOP8 footprints are for the same
9+
micro. Dynamically highlighting all components in the same group on the rendering
10+
of the pcb makes manually populating the board much easier.
611

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

920
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.
1021

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

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

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

2436
`units.py` is borrowed from [KiBom](https://github.com/SchrodingersGat/KiBoM)
2537
plugin (MIT license).

icons/plugin_icon_big.png

9.29 KB
Loading

0 commit comments

Comments
 (0)