Skip to content

Commit

Permalink
Update readme language
Browse files Browse the repository at this point in the history
  • Loading branch information
qu1ck committed Mar 22, 2023
1 parent 4f07dd7 commit f3f24af
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,22 @@

![icon](https://i.imgur.com/js4kDOn.png)

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 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, 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).
This plugin generates a convenient Bill of Materials (BOM) listing with the
ability to visually correlate and easily search for components and their placements
on the PCB. It is particularly useful when hand-soldering a prototype, as it allows
users to quickly find locations of components groups on the board. It is also possible
to reverse lookup the component group by clicking on a footprint on the board drawing.

The plugin utilizes Pcbnew python API to read PCB data and render silkscreen, fab layer,
footprint pads, text, and drawings. BOM table fields and grouping is fully configurable,
additional columns, such as a manufacturer ID, can be added in Schematic editor and
imported either through the netlist file, XML file generated by Eeschema's internal
BOM tool, or from board file itself.

There is an option to include tracks/zones data as well as netlist information allowing
dynamic highlight of nets on the board.

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 @@ -26,7 +27,7 @@ and can be packaged with documentation of your project or hosted anywhere on the

## Installation and Usage

See [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki) for instructions.
See [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki/Installation) for instructions.

## License and credits

Expand Down

0 comments on commit f3f24af

Please sign in to comment.