From 36efb53aaede38389aa3fcaa0bd0ea2868c1d8cc Mon Sep 17 00:00:00 2001 From: Jonas Gunz Date: Sat, 14 Jan 2023 02:40:35 +0100 Subject: README --- README.md | 18 ++++++++++++++++-- img/big.png | Bin 0 -> 21272 bytes img/bottom.png | Bin 0 -> 23388 bytes 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 img/big.png create mode 100644 img/bottom.png diff --git a/README.md b/README.md index 5f92c88..c64f62f 100644 --- a/README.md +++ b/README.md @@ -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(, , , 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 -// Arguments are in GridFinity units gridfinity(2, 1, 2, lip=true, magnets=false); ``` + +## License + +Licensed under the MIT License. Consult `LICENSE`. diff --git a/img/big.png b/img/big.png new file mode 100644 index 0000000..9fad9a0 Binary files /dev/null and b/img/big.png differ diff --git a/img/bottom.png b/img/bottom.png new file mode 100644 index 0000000..cc3914c Binary files /dev/null and b/img/bottom.png differ -- cgit v1.2.3