2.5 RELEASE

Update _catmull_rom_spline.scad

README.md

@@ -1,17 +1,25 @@
-# dotSCAD 2.2
+# dotSCAD 2.5
 
-> **Reduce the burden of 3D modeling in mathematics.**
+> **Reduce the burden of mathematics/algorithm when playing OpenSCAD.**
 
-![dotSCAD](featured_img/LeopardCatTaiwan.JPG)
+![dotSCAD](featured_img/RandomCityTaiwan.JPG)
 
 [![license/LGPL](LICENSE.svg)](https://github.com/JustinSDK/lib-openscad/blob/master/LICENSE)
 
 ## Introduction
 
-**Based on OpenSCAD 2019.05.** For old OpenSCAD versions, please use dotSCAD 1.3. You can download all versions from the [releases](https://github.com/JustinSDK/dotSCAD/releases).
+**This library requires OpenSCAD 2019.05 or later.** 
+
+Some of my [3D models](https://github.com/JustinSDK/dotSCAD#examples) require complex mathematics/algorithm. I extract them into dotSCAD. Hope it helps when you're playing OpenSCAD.
+
+The idea of the name dotSCAD comes from the filename extension ".scad" of OpenSCAD. 
+
+## Get Started
 
 OpenSCAD uses three library locations, the installation library, built-in library, and user defined libraries. It's convenient to set `OPENSCADPATH`. Check [Setting OPENSCADPATH](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Libraries#Setting_OPENSCADPATH) in [OpenSCAD User Manual/Libraries](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Libraries) for details.
 
+**I set `OPENSCADPATH` to the `src` folder of dotSCAD so all examples here start searching modules or functions from `src`.**
+
 Every module or function is located in the file which has the same name as the module or the function. For example, if you want to use the `line2d` module to draw a line, `use <line2d.scad>;` first. 
 
 	use <line2d.scad>;
@@ -20,151 +28,217 @@ Every module or function is located in the file which has the same name as the m
 
 Some module files are organized in a directory. For example, px_circle.scad exists in `pixel` directory. You have to prefix the directory name when including `px_circle`.
 
-    use <pixel/px_circle.scad>;
+    use <voxel/vx_circle.scad>;
 	
-	points = px_circle(radius = 10);
+	points = vx_circle(radius = 10);
 	for(pt = points) {
         translate(pt) square(1);
 	}
 
 ## Examples
 
-See [examples](examples).
+These examples incubate dotSCAD and dotSCAD refactors these examples. See [examples](examples#dogfooding-examples).
 
-![examples](examples/images/gallery.JPG)
+[![examples](examples/images/gallery.JPG)](examples#dogfooding-examples)
 
 ## Documentation
 
-- 2D
-    - [arc](https://openhome.cc/eGossip/OpenSCAD/lib2x-arc.html)
-	- [pie](https://openhome.cc/eGossip/OpenSCAD/lib2x-pie.html)
-	- [rounded_square](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_square.html)
-	- [line2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-line2d.html)
-	- [polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-polyline2d.html)
-	- [hull_polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-hull_polyline2d.html)
-	- [hexagons](https://openhome.cc/eGossip/OpenSCAD/lib2x-hexagons.html)
-	- [polytransversals](https://openhome.cc/eGossip/OpenSCAD/lib2x-polytransversals.html)
-    - [multi_line_text](https://openhome.cc/eGossip/OpenSCAD/lib2x-multi_line_text.html)
-	- [voronoi2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-voronoi2d.html)
+### 2D Module
+- [arc](https://openhome.cc/eGossip/OpenSCAD/lib2x-arc.html)
+- [pie](https://openhome.cc/eGossip/OpenSCAD/lib2x-pie.html)
+- [rounded_square](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_square.html)
+- [line2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-line2d.html)
+- [polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-polyline2d.html)
+- [hull_polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-hull_polyline2d.html)
+- [hexagons](https://openhome.cc/eGossip/OpenSCAD/lib2x-hexagons.html)
+- [multi_line_text](https://openhome.cc/eGossip/OpenSCAD/lib2x-multi_line_text.html)
+- [polygon_hull](https://openhome.cc/eGossip/OpenSCAD/lib2x-polygon_hull.html)
 
-- 3D
-	- [rounded_cube](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_cube.html)
-    - [rounded_cylinder](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_cylinder.html)
-    - [crystal_ball](https://openhome.cc/eGossip/OpenSCAD/lib2x-crystal_ball.html)
-	- [line3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-line3d.html)
-	- [polyline3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-polyline3d.html)
-	- [hull_polyline3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-hull_polyline3d.html)
-	- [function_grapher](https://openhome.cc/eGossip/OpenSCAD/lib2x-function_grapher.html)
-	- [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html)
-	- [starburst](https://openhome.cc/eGossip/OpenSCAD/lib2x-starburst.html)
-	- [voronoi3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-voronoi3d.html)
-	
-- Transformation
-    - [along_with](https://openhome.cc/eGossip/OpenSCAD/lib2x-along_with.html)
-	- [hollow_out](https://openhome.cc/eGossip/OpenSCAD/lib2x-hollow_out.html)
-	- [bend](https://openhome.cc/eGossip/OpenSCAD/lib2x-bend.html)
-	- [shear](https://openhome.cc/eGossip/OpenSCAD/lib2x-shear.html)
+### 3D Module
+- [rounded_cube](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_cube.html)
+- [rounded_cylinder](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_cylinder.html)
+- [crystal_ball](https://openhome.cc/eGossip/OpenSCAD/lib2x-crystal_ball.html)
+- [line3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-line3d.html)
+- [polyline3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-polyline3d.html)
+- [hull_polyline3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-hull_polyline3d.html)
+- [function_grapher](https://openhome.cc/eGossip/OpenSCAD/lib2x-function_grapher.html)
+- [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html)
+- [loft](https://openhome.cc/eGossip/OpenSCAD/lib2x-loft.html)
+- [starburst](https://openhome.cc/eGossip/OpenSCAD/lib2x-starburst.html)
+- [polyhedron_hull](https://openhome.cc/eGossip/OpenSCAD/lib2x-polyhedron_hull.html)
 
-- Functon
-	- [rotate_p](https://openhome.cc/eGossip/OpenSCAD/lib2x-rotate_p.html)
-	- [cross_sections](https://openhome.cc/eGossip/OpenSCAD/lib2x-cross_sections.html)
-	- [paths2sections](https://openhome.cc/eGossip/OpenSCAD/lib2x-paths2sections.html)
-	- [path_scaling_sections](https://openhome.cc/eGossip/OpenSCAD/lib2x-path_scaling_sections.html)
-	- [bijection_offset](https://openhome.cc/eGossip/OpenSCAD/lib2x-bijection_offset.html)
-	- [in_polyline](https://openhome.cc/eGossip/OpenSCAD/lib2x-in_polyline.html)
-	- [in_shape](https://openhome.cc/eGossip/OpenSCAD/lib2x-in_shape.html)
-	- [midpt_smooth](https://openhome.cc/eGossip/OpenSCAD/lib2x-midpt_smooth.html)
-	- [trim_shape](https://openhome.cc/eGossip/OpenSCAD/lib2x-trim_shape.html)
-	- [triangulate](https://openhome.cc/eGossip/OpenSCAD/lib2x-triangulate.html)
-	
-- Path
-    - [arc_path](https://openhome.cc/eGossip/OpenSCAD/lib2x-arc_path.html)
-	- [circle_path](https://openhome.cc/eGossip/OpenSCAD/lib2x-circle_path.html)
-    - [bspline_curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-bspline_curve.html)
-	- [bezier_curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-bezier_curve.html)
-	- [bezier_surface](https://openhome.cc/eGossip/OpenSCAD/lib2x-bezier_surface.html)
-	- [bezier_smooth](https://openhome.cc/eGossip/OpenSCAD/lib2x-bezier_smooth.html)
-    - [helix](https://openhome.cc/eGossip/OpenSCAD/lib2x-helix.html)
-    - [golden_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-golden_spiral.html)
-    - [archimedean_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-archimedean_spiral.html)
-    - [sphere_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-sphere_spiral.html)
-	- [torus_knot](https://openhome.cc/eGossip/OpenSCAD/lib2x-torus_knot.html)
+### Transformation
+- [along_with](https://openhome.cc/eGossip/OpenSCAD/lib2x-along_with.html)
+- [hollow_out](https://openhome.cc/eGossip/OpenSCAD/lib2x-hollow_out.html)
+- [bend](https://openhome.cc/eGossip/OpenSCAD/lib2x-bend.html)
+- [shear](https://openhome.cc/eGossip/OpenSCAD/lib2x-shear.html)
 
-- Extrusion
-    - [box_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-box_extrude.html)
-	- [ellipse_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-ellipse_extrude.html)
-    - [stereographic_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-stereographic_extrude.html)
-	- [rounded_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_extrude.html)
+### 2D Function
+- [in_shape](https://openhome.cc/eGossip/OpenSCAD/lib2x-in_shape.html)
+- [bijection_offset](https://openhome.cc/eGossip/OpenSCAD/lib2x-bijection_offset.html)	
+- [trim_shape](https://openhome.cc/eGossip/OpenSCAD/lib2x-trim_shape.html)
+- [triangulate](https://openhome.cc/eGossip/OpenSCAD/lib2x-triangulate.html)
+- [contours](https://openhome.cc/eGossip/OpenSCAD/lib2x-contours.html)
+- [lines_intersection](https://openhome.cc/eGossip/OpenSCAD/lib2x-lines_intersection.html)
 
-- 2D Shape
-    - [shape_taiwan](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_taiwan.html)
-	- [shape_arc](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_arc.html)
-	- [shape_pie](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_pie.html)
-	- [shape_ellipse](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_ellipse.html)
-    - [shape_square](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_square.html)
-	- [shape_trapezium](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_trapezium.html)
-	- [shape_cyclicpolygon](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_cyclicpolygon.html)
-    - [shape_pentagram](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_pentagram.html)	
-    - [shape_starburst](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_starburst.html)	    
-	- [shape_superformula](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_superformula.html)
-	- [shape_glued2circles](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_glued2circles.html)
-	- [shape_path_extend](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_path_extend.html)		
+### 2D/3D Function
+- [cross_sections](https://openhome.cc/eGossip/OpenSCAD/lib2x-cross_sections.html)
+- [paths2sections](https://openhome.cc/eGossip/OpenSCAD/lib2x-paths2sections.html)
+- [path_scaling_sections](https://openhome.cc/eGossip/OpenSCAD/lib2x-path_scaling_sections.html)
+- [bezier_surface](https://openhome.cc/eGossip/OpenSCAD/lib2x-bezier_surface.html)	
+- [bezier_smooth](https://openhome.cc/eGossip/OpenSCAD/lib2x-bezier_smooth.html)	
+- [midpt_smooth](https://openhome.cc/eGossip/OpenSCAD/lib2x-midpt_smooth.html)
+- [in_polyline](https://openhome.cc/eGossip/OpenSCAD/lib2x-in_polyline.html)
 
-- 2D Shape Extrusion
-	- [bend_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-bend_extrude.html)
-	- [path_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-path_extrude.html)
-	- [ring_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-ring_extrude.html)
-	- [helix_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-helix_extrude.html)
-	- [golden_spiral_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-golden_spiral_extrude.html)
-	- [archimedean_spiral_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-archimedean_spiral_extrude.html)
-	- [sphere_spiral_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-sphere_spiral_extrude.html)
+### Path
+- [arc_path](https://openhome.cc/eGossip/OpenSCAD/lib2x-arc_path.html)
+- [bspline_curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-bspline_curve.html)
+- [bezier_curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-bezier_curve.html)
+- [helix](https://openhome.cc/eGossip/OpenSCAD/lib2x-helix.html)
+- [golden_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-golden_spiral.html)
+- [archimedean_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-archimedean_spiral.html)
+- [sphere_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-sphere_spiral.html)
+- [torus_knot](https://openhome.cc/eGossip/OpenSCAD/lib2x-torus_knot.html)
+- [curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-curve.html)
+- [bauer_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-bauer_spiral.html)
+- [fibonacci_lattice](https://openhome.cc/eGossip/OpenSCAD/lib2x-fibonacci_lattice.html)
 
-- Utilities
-	- [util/sub_str](https://openhome.cc/eGossip/OpenSCAD/lib2x-sub_str.html)
-	- [util/split_str](https://openhome.cc/eGossip/OpenSCAD/lib2x-split_str.html)
-	- [util/parse_number](https://openhome.cc/eGossip/OpenSCAD/lib2x-parse_number.html)
-    - [util/reverse](https://openhome.cc/eGossip/OpenSCAD/lib2x-reverse.html)
-	- [util/slice](https://openhome.cc/eGossip/OpenSCAD/lib2x-slice.html)
-	- [util/sort](https://openhome.cc/eGossip/OpenSCAD/lib2x-sort.html)
-	- [util/rand](https://openhome.cc/eGossip/OpenSCAD/lib2x-rand.html)
-	- [util/fibseq](https://openhome.cc/eGossip/OpenSCAD/lib2x-fibseq.html)	
+### Extrusion
+- [box_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-box_extrude.html)
+- [ellipse_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-ellipse_extrude.html)
+- [stereographic_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-stereographic_extrude.html)
+- [rounded_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-rounded_extrude.html)
+- [bend_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-bend_extrude.html)	
 
-- Matrix
-	- [matrix/m_cumulate](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_cumulate.html)	
-	- [matrix/m_translation](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_translation.html)
-	- [matrix/m_rotation](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_rotation.html)
-	- [matrix/m_scaling](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_scaling.html)
-	- [matrix/m_mirror](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_mirror.html)
-	- [matrix/m_shearing](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_shearing.html)
+### 2D Shape
+- [shape_taiwan](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_taiwan.html)
+- [shape_arc](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_arc.html)
+- [shape_pie](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_pie.html)
+- [shape_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_circle.html)
+- [shape_ellipse](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_ellipse.html)
+- [shape_square](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_square.html)
+- [shape_trapezium](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_trapezium.html)
+- [shape_cyclicpolygon](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_cyclicpolygon.html)
+- [shape_pentagram](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_pentagram.html)	
+- [shape_starburst](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_starburst.html)	    
+- [shape_superformula](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_superformula.html)
+- [shape_path_extend](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_path_extend.html)
+- [shape_liquid_splitting](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_liquid_splitting.html)
 
-- Turtle
-    - [turtle/turtle2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-turtle2d.html)
-    - [turtle/turtle3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-turtle3d.html)
-    - [turtle/t2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-t2d.html)
-    - [turtle/t3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-t3d.html)
+### 2D Shape Extrusion
+- [path_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-path_extrude.html)
+- [ring_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-ring_extrude.html)
+- [helix_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-helix_extrude.html)
+- [golden_spiral_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-golden_spiral_extrude.html)
+- [archimedean_spiral_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-archimedean_spiral_extrude.html)
+- [sphere_spiral_extrude](https://openhome.cc/eGossip/OpenSCAD/lib2x-sphere_spiral_extrude.html)
 
-- Pixel
-    - [pixel/px_line](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_line.html)
-	- [pixel/px_polyline](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_polyline.html)
-	- [pixel/px_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_circle.html)
-	- [pixel/px_cylinder](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_cylinder.html)
-	- [pixel/px_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_sphere.html)
-	- [pixel/px_polygon](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_polygon.html)
-	- [pixel/px_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_from.html)
-    - [pixel/px_ascii](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_ascii.html)
-	- [pixel/px_gray](https://openhome.cc/eGossip/OpenSCAD/lib2x-px_gray.html)
+### Util
+- [util/sub_str](https://openhome.cc/eGossip/OpenSCAD/lib2x-sub_str.html)
+- [util/split_str](https://openhome.cc/eGossip/OpenSCAD/lib2x-split_str.html)
+- [util/parse_number](https://openhome.cc/eGossip/OpenSCAD/lib2x-parse_number.html)
+- [util/reverse](https://openhome.cc/eGossip/OpenSCAD/lib2x-reverse.html)
+- [util/slice](https://openhome.cc/eGossip/OpenSCAD/lib2x-slice.html)
+- [util/sort](https://openhome.cc/eGossip/OpenSCAD/lib2x-sort.html)
+- [util/rand](https://openhome.cc/eGossip/OpenSCAD/lib2x-rand.html)
+- [util/fibseq](https://openhome.cc/eGossip/OpenSCAD/lib2x-fibseq.html)	
+- [util/bsearch](https://openhome.cc/eGossip/OpenSCAD/lib2x-bsearch.html)	
+- [util/has](https://openhome.cc/eGossip/OpenSCAD/lib2x-has.html)
+- [util/dedup](https://openhome.cc/eGossip/OpenSCAD/lib2x-dedup.html)
+- [util/flat](https://openhome.cc/eGossip/OpenSCAD/lib2x-flat.html)
+- [util/sum](https://openhome.cc/eGossip/OpenSCAD/lib2x-sum.html)
+- [util/zip](https://openhome.cc/eGossip/OpenSCAD/lib2x-zip.html)
+- [util/lerp](https://openhome.cc/eGossip/OpenSCAD/lib2x-lerp.html)
+- [util/choose](https://openhome.cc/eGossip/OpenSCAD/lib2x-choose.html)
 
-- Part
-    - [part/connector_peg](https://openhome.cc/eGossip/OpenSCAD/lib2x-connector_peg.html)
-	- [part/cone](https://openhome.cc/eGossip/OpenSCAD/lib2x-cone.html)
-	- [part/joint_T](https://openhome.cc/eGossip/OpenSCAD/lib2-joint_T.html)
-	
-## Bugs and Feedback
+### Matrix
+- [matrix/m_cumulate](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_cumulate.html)	
+- [matrix/m_translation](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_translation.html)
+- [matrix/m_rotation](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_rotation.html)
+- [matrix/m_scaling](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_scaling.html)
+- [matrix/m_mirror](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_mirror.html)
+- [matrix/m_shearing](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_shearing.html)
+- [matrix/m_determinant](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_determinant.html)
 
-For bugs, questions and discussions please use the [Github Issues](https://github.com/JustinSDK/dotSCAD/issues).
+### Point Transformation
+- [ptf/ptf_rotate](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_rotate.html)
+- [ptf/ptf_x_twist](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_x_twist.html)
+- [ptf/ptf_y_twist](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_y_twist.html)
+- [ptf/ptf_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_circle.html)
+- [ptf/ptf_bend](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_bend.html)
+- [ptf/ptf_ring](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_ring.html)
+- [ptf/ptf_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_sphere.html)
+- [ptf/ptf_torus](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_torus.html)
 
-## About dotSCAD
+----
 
-I've been using OpenSCAD for years and created some funny things. Some of them include several important ideas and details. To prevent forgetfulness, I decided to [write them down](https://openhome.cc/eGossip/OpenSCAD/). Some examples developed in the documentation are useful so I elaborate them into this library.
+### Turtle
+- [turtle/turtle2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-turtle2d.html)
+- [turtle/turtle3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-turtle3d.html)
+- [turtle/t2d](https://openhome.cc/eGossip/OpenSCAD/lib2x-t2d.html)
+- [turtle/t3d](https://openhome.cc/eGossip/OpenSCAD/lib2x-t3d.html)
+- [turtle/footprints2](https://openhome.cc/eGossip/OpenSCAD/lib2x-footprints2.html)
+- [turtle/footprints3](https://openhome.cc/eGossip/OpenSCAD/lib2x-footprints3.html)
+- [turtle/lsystem2](https://openhome.cc/eGossip/OpenSCAD/lib2x-lsystem2.html)
+- [turtle/lsystem3](https://openhome.cc/eGossip/OpenSCAD/lib2x-lsystem3.html)
 
-The idea of the name dotSCAD comes from the filename extension ".scad" of OpenSCAD. 
+### Voxel
+- [voxel/vx_line](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_line.html)
+- [voxel/vx_polyline](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_polyline.html)
+- [voxel/vx_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_circle.html)
+- [voxel/vx_cylinder](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_cylinder.html)
+- [voxel/vx_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_sphere.html)
+- [voxel/vx_polygon](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_polygon.html)
+- [voxel/vx_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_from.html)
+- [voxel/vx_ascii](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_ascii.html)
+- [voxel/vx_gray](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_gray.html)
+- [voxel/vx_union](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_union.html)
+- [voxel/vx_intersection](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_intersection.html)
+- [voxel/vx_difference](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_difference.html)
+- [voxel/vx_bezier](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_bezier.html)
+- [voxel/vx_curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_curve.html)
+- [voxel/vx_contour](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_contour.html)
+
+### Part
+- [part/connector_peg](https://openhome.cc/eGossip/OpenSCAD/lib2x-connector_peg.html)
+- [part/cone](https://openhome.cc/eGossip/OpenSCAD/lib2x-cone.html)
+- [part/joint_T](https://openhome.cc/eGossip/OpenSCAD/lib2x-joint_T.html)
+
+### Surface
+- [surface/sf_square](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_square.html)
+- [surface/sf_bend](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_bend.html)
+- [surface/sf_ring](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_ring.html)
+- [surface/sf_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_sphere.html)
+- [surface/sf_torus](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_torus.html)
+- [surface/sf_solidify](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_solidify.html)
+
+### Noise
+- [noise/nz_perlin1](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin1.html)
+- [noise/nz_perlin1s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin1s.html)
+- [noise/nz_perlin2](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin2.html)
+- [noise/nz_perlin2s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin2s.html)
+- [noise/nz_perlin3](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin3.html)
+- [noise/nz_perlin3s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin3s.html)
+- [noise/nz_worley2](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley2.html)
+- [noise/nz_worley2s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley2s.html)
+- [noise/nz_worley3](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley3.html)
+- [noise/nz_worley3s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley3s.html)
+- [noise/nz_cell](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_cell.html)
+
+### Voronoi
+
+- [voronoi/vrn2_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_from.html)
+- [voronoi/vrn2_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_space.html)
+- [voronoi/vrn2_cells_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_cells_from.html)
+- [voronoi/vrn2_cells_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_cells_space.html)
+- [voronoi/vrn3_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_from.html)
+- [voronoi/vrn3_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_space.html)
+
+### Maze
+
+- [maze/mz_square_cells](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_cells.html)
+- [maze/mz_square_get](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_get.html)
+- [maze/mz_square_walls](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_walls.html)
+- [maze/mz_hex_walls](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_hex_walls.html)
+- [maze/mz_square_initialize](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_initialize.html)
+- [maze/mz_hamiltonian](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_hamiltonian.html)

RELEASE.md

@@ -1,5 +1,153 @@
 > Version numbers are based on [Semantic Versioning](https://semver.org/).
 
+# v2.5
+
+Deprecated:
+- `polytransversals`
+- `shape_glued2circles`. Use `shape_liquid_splitting` instead.
+
+New modules and functions:
+
+- 2D Module
+  - [polygon_hull](https://openhome.cc/eGossip/OpenSCAD/lib2x-polygon_hull.html)
+
+- 3D Module
+  - [polyhedron_hull](https://openhome.cc/eGossip/OpenSCAD/lib2x-polyhedron_hull.html)
+
+- Path
+  - [curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-curve.html)
+  - [bauer_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-bauer_spiral.html)
+  - [fibonacci_lattice](https://openhome.cc/eGossip/OpenSCAD/lib2x-fibonacci_lattice.html)
+
+- 2D Shape
+  - [shape_liquid_splitting](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_liquid_splitting.html)
+
+- Util
+  - [util/lerp](https://openhome.cc/eGossip/OpenSCAD/lib2x-lerp.html)
+  - [util/choose](https://openhome.cc/eGossip/OpenSCAD/lib2x-choose.html)
+
+- Voxel
+  - [voxel/vx_bezier](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_bezier.html)
+  - [voxel/vx_curve](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_curve.html)
+  - [voxel/vx_contour](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_contour.html)
+
+- Maze
+  - [maze/mz_square_cells](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_cells.html)
+  - [maze/mz_square_get](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_get.html)
+  - [maze/mz_square_walls](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_walls.html)
+  - [maze/mz_hex_walls](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_hex_walls.html)
+  - [maze/mz_square_initialize](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_initialize.html)
+  - [maze/mz_hamiltonian](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_hamiltonian.html)
+
+# v2.4
+
+Deprecated:
+- Pixel. Use Voxel instead.
+- voronoi2d: use [voronoi/vrn2_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_from.html) instead.
+- voronoi3d: use [voronoi/vrn3_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_from.html) instead.
+
+Improved:
+- polyline2d: improved middle-point drawing, support `joinStyle` parameter.
+- box_extrude: added `bottom_thicnkess` parameter.
+
+New modules and functions:
+- 2D Function
+  - [lines_intersection](https://openhome.cc/eGossip/OpenSCAD/lib2x-lines_intersection.html)
+
+- Util
+  - [util/sum](https://openhome.cc/eGossip/OpenSCAD/lib2x-sum.html)
+  - [util/zip](https://openhome.cc/eGossip/OpenSCAD/lib2x-zip.html)
+
+- Turtle
+  - [turtle/footprints2](https://openhome.cc/eGossip/OpenSCAD/lib2x-footprints2.html)
+  - [turtle/footprints3](https://openhome.cc/eGossip/OpenSCAD/lib2x-footprints3.html)
+  - [turtle/lsystem2](https://openhome.cc/eGossip/OpenSCAD/lib2x-lsystem2.html)
+  - [turtle/lsystem3](https://openhome.cc/eGossip/OpenSCAD/lib2x-lsystem3.html)
+
+- Voxel
+  - [voxel/vx_line](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_line.html)
+  - [voxel/vx_polyline](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_polyline.html)
+  - [voxel/vx_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_circle.html)
+  - [voxel/vx_cylinder](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_cylinder.html)
+  - [voxel/vx_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_sphere.html)
+  - [voxel/vx_polygon](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_polygon.html)
+  - [voxel/vx_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_from.html)
+  - [voxel/vx_ascii](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_ascii.html)
+  - [voxel/vx_gray](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_gray.html)
+  - [voxel/vx_union](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_union.html)
+  - [voxel/vx_intersection](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_intersection.html)
+  - [voxel/vx_difference](https://openhome.cc/eGossip/OpenSCAD/lib2x-vx_difference.html)
+
+- Matrix
+  - [matrix/m_determinant](https://openhome.cc/eGossip/OpenSCAD/lib2x-m_determinant.html)
+
+- Voronoi
+  - [voronoi/vrn2_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_from.html)
+  - [voronoi/vrn2_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_space.html)
+  - [voronoi/vrn2_cells_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_cells_from.html)
+  - [voronoi/vrn2_cells_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_cells_space.html)
+  - [voronoi/vrn3_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_from.html)
+  - [voronoi/vrn3_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_space.html)
+
+# v2.3
+Bugfixes:
+- `helix_extrude`: wrong orientation when `CLK`.
+
+Deprecated:
+- polysections: use [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) instead.
+- rotate_p: use [ptf_rotate](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_rotate.html) instead.
+- circle_path: use [shape_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_circle.html) instead.
+
+New modules and functions:
+- 3D Module
+  - [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html)
+  - [loft](https://openhome.cc/eGossip/OpenSCAD/lib2x-loft.html)
+- 2D Function
+  - [contours](https://openhome.cc/eGossip/OpenSCAD/lib2x-contours.html)
+- Path
+  - [shape_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-shape_circle.html)
+- Util
+  - [util/bsearch](https://openhome.cc/eGossip/OpenSCAD/lib2x-bsearch.html)
+  - [util/has](https://openhome.cc/eGossip/OpenSCAD/lib2x-has.html)
+  - [util/dedup](https://openhome.cc/eGossip/OpenSCAD/lib2x-dedup.html)
+  - [util/flat](https://openhome.cc/eGossip/OpenSCAD/lib2x-flat.html)
+- Point transformation
+  - [ptf/ptf_rotate](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_rotate.html)
+  - [ptf/ptf_x_twist](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_x_twist.html)
+  - [ptf/ptf_y_twist](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_y_twist.html)
+  - [ptf/ptf_circle](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_circle.html)
+  - [ptf/ptf_bend](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_bend.html)
+  - [ptf/ptf_ring](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_ring.html)
+  - [ptf/ptf_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_sphere.html)
+  - [ptf/ptf_torus](https://openhome.cc/eGossip/OpenSCAD/lib2x-ptf_torus.html)
+- Surface
+  - [surface/sf_square](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_square.html)
+  - [surface/sf_bend](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_bend.html)
+  - [surface/sf_ring](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_ring.html)
+  - [surface/sf_sphere](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_sphere.html)
+  - [surface/sf_torus](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_torus.html)
+  - [surface/sf_solidify](https://openhome.cc/eGossip/OpenSCAD/lib2x-sf_solidify.html)
+- Noise
+  - [noise/nz_perlin1](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin1.html)
+  - [noise/nz_perlin1s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin1s.html)
+  - [noise/nz_perlin2](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin2.html)
+  - [noise/nz_perlin2s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin2s.html)
+  - [noise/nz_perlin3](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin3.html)
+  - [noise/nz_perlin3s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_perlin3s.html)
+  - [noise/nz_worley2](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley2.html)
+  - [noise/nz_worley2s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley2s.html)
+  - [noise/nz_worley3](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley3.html)
+  - [noise/nz_worley3s](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_worley3s.html)
+  - [noise/nz_cell](https://openhome.cc/eGossip/OpenSCAD/lib2x-nz_cell.html)
+
+# v2.2.1
+Bugfixes:
+- `util/sort`: z not sorted.
+
+Improvements:
+- Faster when the `style` of `function_grapher` is `"LINES"` or `"HULL_LINES"`.
+- Dedup pixels of `pixel/px_polyline`, `pixel/px_circle`, `pixel/px_cylinder`, `pixel/px_sphere`, `pixel/px_polygon`.
+
 # v2.2
 - Bugfixes
   - `util/sort`: fix "search term not found" warning when `by` is `"idx"`.