From 07aff71e1e91a568bc91f16d6ad38fe8ed0040cc Mon Sep 17 00:00:00 2001 From: sursini Date: Sat, 28 Dec 2024 20:27:46 +0000 Subject: [PATCH] Update Readme.md --- Readme.md | 76 +++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/Readme.md b/Readme.md index 1bbeca3..1517a7e 100644 --- a/Readme.md +++ b/Readme.md @@ -1,38 +1,38 @@ -# Metalib - -Libraries for Metal makers - - -## Miter tubes module - - -This module generates a sequence of mitered tubes based on the provided section lengths, with options for customizing their dimensions and unfolding their arrangement. - -Parameters: -- `sections` (array): An array of section lengths, each specifying the length of an individual tube. - Example: `[10, 20, 30]` will create three tubes of lengths 10, 20, and 30 units respectively. - -- `height` (number): The height of each tube. This value defines the dimension perpendicular - to the tube's length and depth. - -- `depth` (number): The depth of each tube. This value defines the dimension perpendicular - to the tube's length and height. - -- `unfold` (boolean, optional): Determines whether the sequence of tubes should be unfolded - for easier visualization or fabrication. When `true`, the tubes are laid out in a flat arrangement. - Defaults to `false`. - -As an example let's create metalon arch : -```python -include ; -include ; - -yrot(-90) - miter_tubes([400,500,400],30,20,start=false,end=false); -`` - - -![image info](./resources/arch.png) - - - +# Metalib + +Libraries for Metal makers + + +## Miter tubes module + + +This module generates a sequence of mitered tubes based on the provided section lengths, with options for customizing their dimensions and unfolding their arrangement. + +Parameters: +- `sections` (array): An array of section lengths, each specifying the length of an individual tube. + Example: `[10, 20, 30]` will create three tubes of lengths 10, 20, and 30 units respectively. + +- `height` (number): The height of each tube. This value defines the dimension perpendicular + to the tube's length and depth. + +- `depth` (number): The depth of each tube. This value defines the dimension perpendicular + to the tube's length and height. + +- `unfold` (boolean, optional): Determines whether the sequence of tubes should be unfolded + for easier visualization or fabrication. When `true`, the tubes are laid out in a flat arrangement. + Defaults to `false`. + +As an example let's create metalon arch : +```python +include ; +include ; + +yrot(-90) + miter_tubes([400,500,400],30,20,start=false,end=false); +``` + + +![](./resources/arch.png) + + +