Skip to content

Commit 9de0f76

Browse files
committed
Update readme
1 parent f9447dd commit 9de0f76

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

+7-18
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ The goal is to algorithmically melt a PCB design, smoothing all tracks in a pred
77

88
For best results, use in conjunction with this [teardrop plugin](https://github.com/NilujePerchut/kicad_scripts).
99

10+
__Note:__ Currently, the teardrop plugin has not been ported fully ported to KiCad 6. I've fixed the behaviour with native arcs on [my fork of it](https://github.com/mitxela/kicad-teardrops/tree/mitxela/V6.0) which should hopefully be merged in soon.
11+
1012
I have written extensively about my kicad melting experiments [here](https://mitxela.com/projects/melting_kicad) and [here](https://mitxela.com/projects/melting_kicad_2).
1113

1214
## Use
@@ -25,33 +27,20 @@ Otherwise, the curves are generated from many small straight sections. 2 or 3 pa
2527

2628
"Radius" is the maximum radius curve that would result from a 90° bend. A smaller curve will be used if the tracks are shorter, or if the angle between them is sharper. The resulting curves will always pass through at least one point of the original tracks, so individual curves can be controlled by splitting tracks into smaller sections. If a curve has too large a radius, placing a small 45° bend will make it smaller. Similarly, if a bigger radius is needed for certain tracks, you can draw an approximate curve with free-angle tracks to achieve this.
2729

28-
__Note:__ Currently, the teardrop plugin has not been fully ported to KiCad 6. It does not yet understand native arcs, but work is ongoing.
29-
3030
## Todo
3131
- Limit minimum angle between tracks, to avoid unnecessary subdivisions
3232
- In KiCad 6, the undo history state is broken when the plugin runs. A single tap of Ctrl+Z should undo the rounding.
3333

34-
## Installation
35-
Clone or unzip this repository in a KiCad plugin folder.
36-
37-
- On linux :
38-
- `/usr/share/kicad/scripting/plugins/`
39-
- `~/.kicad/scripting/plugins`
40-
- `~/.kicad_plugins/`
41-
- On macOS :
42-
- `/Applications/kicad/Kicad/Contents/SharedSupport/scripting/plugins`
43-
- `~/Library/Application Support/kicad/scripting/plugins`
44-
- On Windows:
45-
- `C:\Program Files\KiCad\share\kicad\scripting\plugins\`
46-
- `%UserName%\Documents\KiCad\6.0\scripting\plugins\`
47-
48-
You can list the exact paths where KiCad will search for plugins by opening the scripting console in pcbnew and running:
34+
## Installation
35+
Now available from the Plugin and Content manager.
36+
37+
For manual install, clone or unzip this repository in a KiCad plugin folder. You can list the exact paths where KiCad will search for plugins by opening the scripting console in pcbnew and running:
4938
```
5039
import pcbnew
5140
print(pcbnew.GetWizardsSearchPaths())
5241
```
5342

54-
Under Preferences / Preferences / PCB Editor / Action Plugins, you can choose to add a button to the toolbar for quick access to the plugin.
43+
Under Preferences / Preferences / PCB Editor / Action Plugins, you can choose whether to have a button on the toolbar for quick access to the plugin.
5544

5645
## History
5746
This plugin is based on [flexRoundingSuite](https://github.com/jcloiacon/flexRoundingSuite) by Julian Loiacono and [kicad-round-tracks](https://github.com/stimulu/kicad-round-tracks) by Antoine Pintout. My contribution updated the algorithm so that subdivisions are applied equally, resulting in smoother tracks with fewer clearance errors.

0 commit comments

Comments
 (0)