Skip to content

Commit 5079c05

Browse files
committed
Update readme for v1
1 parent 67f11b2 commit 5079c05

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ KiCad's Pcbnew plugins can be placed in following places, depending on
2323
platform.
2424

2525
- Windows
26-
- `{KICAD_INSTALL_PATH}/share/kicad/scripting`
2726
- `{KICAD_INSTALL_PATH}/share/kicad/scripting/plugins`
28-
- `%KICAD_PATH%/scripting`
2927
- `%KICAD_PATH%/scripting/plugins`
30-
- `%APPDATA%/Roaming/kicad/scripting`
3128
- `%APPDATA%/Roaming/kicad/scripting/plugins`
3229

30+
- Linux
31+
- `~/.kicad/scripting/plugins`
32+
- `~/.kicad_plugins`
3333

3434
- MacOS
3535
- `/Applications/kicad/Kicad/Contents/SharedSupport/scripting/plugins`
@@ -45,12 +45,11 @@ with symlinks just copy InteractiveHtmlBom folder into one of plugin
4545
directories.
4646

4747
If you want this plugin to work in all KiCad versions you install, it's
48-
best to put it in user folder (`%APPDATA%` for Windows, `~/` for MacOS).
48+
best to put it in user folder (`%APPDATA%` for Windows, `~/` for Linux/MacOS).
4949

50-
**Linux users can not install this plugin** at the moment because of
51-
wxPython/GTK3 mess. If you try to do it pcbnew will most likely crash.
52-
This _should_ be fixed in KiCad 5.1.
53-
Meanwhile read on below on how to use it as a standalone script.
50+
Some newer linux distributions have wxpython option in KiCad disabled because of
51+
wxPython/GTK3 mess. In that case you have to try to compile KiCad yourself with
52+
scripting enabled or you can use this plugin from command line.
5453

5554
## Usage
5655

@@ -65,11 +64,14 @@ Save the file and press the
6564
![iBOM](https://raw.githubusercontent.com/openscopeproject/InteractiveHtmlBom/master/InteractiveHtmlBom/icon.png)
6665
button on the top toolbar.
6766

68-
On builds that have plugin menu enabled
67+
If the button is not on the toolbar
6968
`Tools -> External Plugins... -> Generate Interactive HTML BOM` also works.
7069

70+
_In recent nightly builds you can choose to hide the plugin button in
71+
pcbnew preferences._
72+
7173
`bom` folder with generated html bom will be created where the board
72-
file is saved. On Windows html bom page will be automatically opened in default
74+
file is saved. Html bom page will be automatically opened in default
7375
browser.
7476

7577
### Standalone script

0 commit comments

Comments
 (0)