diff options
author | Jonas Gunz <himself@jonasgunz.de> | 2023-01-14 02:40:35 +0100 |
---|---|---|
committer | Jonas Gunz <himself@jonasgunz.de> | 2023-01-14 02:40:35 +0100 |
commit | 36efb53aaede38389aa3fcaa0bd0ea2868c1d8cc (patch) | |
tree | ef4c6412651d3dc3c9915e7e01f1b24799bd2a17 /README.md | |
parent | efc260311ebae4aa0b8cc96444dc61d4ecabaf40 (diff) | |
download | oscad_gridfinity-36efb53aaede38389aa3fcaa0bd0ea2868c1d8cc.tar.gz |
README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 16 insertions, 2 deletions
@@ -1,12 +1,26 @@ -# gridfinity-scad +# oscad-gridfinity [GridFinity](https://gridfinity.xyz/) implementation for [OpenSCAD](https://openscad.org/) +![Bottom View](img/bottom.png) + +Create fully parameterized Templates for GridFinity. + +`gridfinity(<x>, <y>, <z>, lip=<>, magnets=<>);` + +* **x, y** Vertical size in *GridFinity* units +* **z** Height in GridFinity units (`z * 7mm`). This in excluding the base and stacking lip. +* **lip** `true/false` Sets wether to put a stacking lip on top. Only works with z >= 1. +* **magnets** `true/false` Sets wether to put holes for magnets in the base. + ## Example ```scad use <gridfinity.scad> -// Arguments are in GridFinity units gridfinity(2, 1, 2, lip=true, magnets=false); ``` + +## License + +Licensed under the MIT License. Consult `LICENSE`. |