aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jonas Gunz <himself@jonasgunz.de> 2023-01-14 02:40:35 +0100
committerGravatar Jonas Gunz <himself@jonasgunz.de> 2023-01-14 02:40:35 +0100
commit36efb53aaede38389aa3fcaa0bd0ea2868c1d8cc (patch)
treeef4c6412651d3dc3c9915e7e01f1b24799bd2a17
parentefc260311ebae4aa0b8cc96444dc61d4ecabaf40 (diff)
downloadoscad_gridfinity-36efb53aaede38389aa3fcaa0bd0ea2868c1d8cc.tar.gz
README
-rw-r--r--README.md18
-rw-r--r--img/big.pngbin0 -> 21272 bytes
-rw-r--r--img/bottom.pngbin0 -> 23388 bytes
3 files changed, 16 insertions, 2 deletions
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(<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`.
diff --git a/img/big.png b/img/big.png
new file mode 100644
index 0000000..9fad9a0
--- /dev/null
+++ b/img/big.png
Binary files differ
diff --git a/img/bottom.png b/img/bottom.png
new file mode 100644
index 0000000..cc3914c
--- /dev/null
+++ b/img/bottom.png
Binary files differ