add doc

2025-08-01 12:30:33 +02:00 · 2021-11-07 16:01:53 +08:00
parent 824aefefd9
commit 3b5af34041
4 changed files with 35 additions and 1 deletions
--- a/docs/images/lib3x-polyhedra_star-1.JPG
+++ b/docs/images/lib3x-polyhedra_star-1.JPG
--- a/docs/lib3x-polyhedra_star.md
+++ b/docs/lib3x-polyhedra_star.md
@@ -0,0 +1,24 @@
+# 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.
+- `height`: The star height. Default to 0.5.
+- `n`: The burst number. Default to 5.
+
+## Examples
+
+	use <polyhedra/star.scad>;
+
+	for(i = [3:6]) {
+		translate([(i - 3) * 2, 0])
+			star(n = i);
+	}
+
+![star](images/lib3x-polyhedra_star-1.JPG)
+