aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f92c88
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# gridfinity-scad
+
+[GridFinity](https://gridfinity.xyz/) implementation for [OpenSCAD](https://openscad.org/)
+
+## Example
+
+```scad
+use <gridfinity.scad>
+
+// Arguments are in GridFinity units
+gridfinity(2, 1, 2, lip=true, magnets=false);
+```