add doc

2025-08-01 12:30:33 +02:00 · 2021-11-05 08:33:44 +08:00
parent 9271c79a3a
commit 4cdeb5b4a6
4 changed files with 24 additions and 2 deletions
--- a/docs/images/lib3x-shape_star-1.JPG
+++ b/docs/images/lib3x-shape_star-1.JPG
--- a/docs/lib3x-star.md
+++ b/docs/lib3x-star.md
@@ -0,0 +1,22 @@
+# shape_star 
+
+Create a star. Default to a pentagram.
+
+**Since:** 3.2
+
+## Parameters
+
+- `outer_radius`: the outer radius of the star. Default to 1.
+- `inner_radius`: the inner radius of the star. Default to 0.381966.
+- `n`: the burst number. Default to 5.
+
+## Examples
+
+	use <shape_star.scad>;
+
+	polygon(shape_star());
+	translate([3, 0, 0]) 
+	    polygon(shape_star(n = 8));
+
+![shape_star](images/lib3x-shape_star-1.JPG)
+