Skip to content

Commit f3f24af

Browse files
committed
Update readme language
1 parent 4f07dd7 commit f3f24af

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,22 @@
33

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

6-
This plugin generates convenient BOM listing with ability to visually correlate
7-
and easily search for components and their placements on the pcb.
8-
9-
This is really useful when hand soldering your prototype and you have to find 50
10-
places where 0.1uF cap should be or which of the SOP8 footprints are for the same
11-
micro. Dynamically highlighting all components in the same group on the rendering
12-
of the pcb makes manually populating the board much easier.
13-
14-
This plugin utilizes Pcbnew python bindings to read pcb data and render
15-
silkscreen, fab layer, footprint pads, text and drawings. Additionally it can
16-
pull data from schematic if you export it through netlist or xml file that
17-
Eeschema can generate from it's internal bom tool. That extra data can be added
18-
as additional columns in the BOM table (for example manufacturer id) or it can be
19-
used to indicate which components should be omitted altogether (dnp field). For
20-
full description of functionality see [wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki).
6+
This plugin generates a convenient Bill of Materials (BOM) listing with the
7+
ability to visually correlate and easily search for components and their placements
8+
on the PCB. It is particularly useful when hand-soldering a prototype, as it allows
9+
users to quickly find locations of components groups on the board. It is also possible
10+
to reverse lookup the component group by clicking on a footprint on the board drawing.
11+
12+
The plugin utilizes Pcbnew python API to read PCB data and render silkscreen, fab layer,
13+
footprint pads, text, and drawings. BOM table fields and grouping is fully configurable,
14+
additional columns, such as a manufacturer ID, can be added in Schematic editor and
15+
imported either through the netlist file, XML file generated by Eeschema's internal
16+
BOM tool, or from board file itself.
17+
18+
There is an option to include tracks/zones data as well as netlist information allowing
19+
dynamic highlight of nets on the board.
20+
21+
For full description of functionality see [wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki).
2122

2223
Generated html page is fully self contained, doesn't need internet connection to work
2324
and can be packaged with documentation of your project or hosted anywhere on the web.
@@ -26,7 +27,7 @@ and can be packaged with documentation of your project or hosted anywhere on the
2627

2728
## Installation and Usage
2829

29-
See [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki) for instructions.
30+
See [project wiki](https://github.com/openscopeproject/InteractiveHtmlBom/wiki/Installation) for instructions.
3031

3132
## License and credits
3233

0 commit comments

Comments
 (0)