Skip to content

Commit 823c587

Browse files
committed
Readme: add note about InteractiveHtmlBom
1 parent aff0621 commit 823c587

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

scripts/README.MD

+16
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ nix-shell shell-kibot.nix
1515

1616
This provides a shell which has `kibot` on its `PATH`.
1717

18+
### shell-interactive-html-bom.nix
19+
20+
Provides a standalone script of
21+
[InteractiveHtmlBom](https://github.com/openscopeproject/InteractiveHtmlBom),
22+
`InteractiveHtmlBom`.
23+
24+
The script requires that the netlist be generated from eeschema,
25+
so that symbol fields (like comment, description) can be used in the ibom.
26+
27+
Some convenience scripts e.g. `generate-x1-ibom.sh` are provided which can
28+
be called with:
29+
30+
```
31+
nix-shell generate-x1-ibom.sh
32+
```
33+
1834
## Transform .kicad_pcb to .scad
1935

2036
### Examples

0 commit comments

Comments
 (0)