Merge branch 'main' of https://github.com/kennetek/gridfinity-rebuilt-openscad

README.md

@@ -1,15 +1,32 @@
-# gridfinity-rebuilt-openscad
-
-A ground-up rebuild of the stock gridfinity bins in OpenSCAD. Started because of a couple slight imperfections and inconsistencies in the Fusion360 parametric bins. Open to feedback, because I could not feasibly test all combinations of bins, so some of them may have issues. I tried my best to exactly match the original gridfinity dimensions, but some of the geometry is slightly incorrect. For instance, the tab angle is 32 degrees instead of 36 degrees, as it made construction easier. The fillets may also be slightly incorrect. However, I think they are negligible differences. The script is also fairly laggy, and will probably take at leaste a minute to render a bin. 
-
-Things this script can do: 
-- any size of bin (width, length, height)
-- any number of compartments (along BOTH x and y axis)
-- togglable scoop
-- togglable holes
-- supportless printing hole structures
-- togglable tabs
-- split tabs and tab alignment
+# Gridfinity Rebuilt in OpenSCAD 
 
+A ground-up port (with a few extra features) of the stock gridfinity bins in OpenSCAD. Open to feedback, because I could not feasibly test all combinations of bins, so some of them may have issues. I tried my best to exactly match the original gridfinity dimensions, but some of the geometry is slightly incorrect (mainly fillets). However, I think they are negligible differences, and will not appear in the printed model. 
 
 [Gridfinity](https://www.youtube.com/watch?v=ra_9zU-mnl8) by [Zack Freedman](https://www.youtube.com/c/ZackFreedman/about)
+
+## Features
+
+[<img src="./images/base_dimension.gif" width="320">]()
+[<img src="./images/compartment_dimension.gif" width="320">]()
+[<img src="./images/height_dimension.gif" width="320">]()
+[<img src="./images/tab_dimension.gif" width="320">]()
+[<img src="./images/holes_dimension.gif" width="320">]()
+
+- any size of bin (width/length/height)
+- any number of compartments (along both X and Y axis)
+- togglable scoop
+- togglable tabs, split tabs, and tab alignment
+- togglable holes (with togglable supportless printing hole structures)
+
+[<img src="./images/slicer_holes.png" height="200">]()
+[<img src="./images/slicer_holes_top.png" height="200">]()
+
+The printable holes allow your slicer to bridge the gap (using the technique shown [here](https://www.youtube.com/watch?v=W8FbHTcB05w)) so that supports are not needed.
+
+
+## Recomendations
+For best results, use a version of OpenSCAD with the fast-csg feature. As of writing, this feature is only implemented in the [development snapshots](https://openscad.org/downloads.html). To enable the feature, go to Edit > Preferences > Features > fast-csg. On my computer, this sped up rendering from 10 minutes down to a couple of seconds, even for comically large bins.  
+
+## Enjoy!
+
+[<img src="./images/spin.gif" width="160">]()