add doc

2025-08-26 16:04:46 +02:00 · 2019-05-20 11:01:57 +08:00
parent 6c0a0bdfb0
commit 8722f971ba
2 changed files with 22 additions and 0 deletions
--- a/docs/images/lib-starburst-1.JPG
+++ b/docs/images/lib-starburst-1.JPG
--- a/docs/lib-starburst.md
+++ b/docs/lib-starburst.md
@@ -0,0 +1,22 @@
+# starburst 
+
+A 3D version of [shape_starburst](https://openhome.cc/eGossip/OpenSCAD/lib-shape_starburst.html). 
+
+## Parameters
+
+- `r1` : The outer radius of the starburst. 
+- `r2` : The inner radius of the starburst.
+- `n`  : The number of vertices. 
+- `height` : The height of the starburst.
+
+## Examples
+
+    include <starburst.scad>;
+
+	starburst(10, 5, 5, 5);
+	translate([20, 0, 0]) starburst(10, 5, 6, 5);
+	translate([40, 0, 0]) starburst(10, 5, 12, 10);
+	translate([60, 0, 0]) starburst(10, 5, 4, 3);
+
+![starburst](images/lib-starburst-1.JPG)
+