documention changes. lots.

1 files changed, 74 insertions, 9 deletions

diff --git a/README.md b/README.md
index a3904a9..1c1cc90 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,10 @@ Side Part:
 :::
 
 3D printable parametric cubbies to store your 3D things. There are two distinct
-parts -- a `bottom` and a `side` -- that are generated to the dimensions of your
-things, then 3D printed and assembled into modular storage units.
+parts — a `bottom` and a `side` — that are generated to the dimensions of your
+things, then 3D printed and assembled into modular storage units. The parts are
+optimized for printing as they are made of sparse structures to save material,
+and lay flat on the print bed.
 
 ## Pictures ##
 
@@ -38,9 +40,12 @@ things, then 3D printed and assembled into modular storage units.
 
 ### 🚫 Do NOT Scale in a Slicer 🚫 ###
 
-Your distribution of this project may have included STL files; these are either
-samples or test prints to verify the fit of the dovetail joints. Cubbies are
-meant to be generated in one of the following ways:
+All models should be generated by specifying the parameters `cubby_width`,
+`cubby_depth`, and `cubby_height` in `cubbies.scad` (ways to do this are
+described below.) The dovetail joints are generated to a constant size
+(controlled through the parameters `tab_width`, `tab_padding`, and
+`tab_tolerance`) and should not be expected to fit after being scaled. Cubbies
+can be generated in in one of the following ways:
 
   * Using the Thingiverse Customizer
 
@@ -49,9 +54,9 @@ meant to be generated in one of the following ways:
     modifying the variables at the top of the `cubbies.scad` file.
 
   * There are two scripts for generating cubbies from the commandline:
-    `shopenscad.sh` (run `./shopenscad.sh -h` for details) generates a single
-    model, and `cubbies.sh` (run `./cubbies.sh -h` for details) can generate
-    entire sets of cubbies.
+    `cubbies.sh` (run `./cubbies.sh -h` for details) can generate entire sets of
+    cubbies, and `shopenscad.sh` (run `./shopenscad.sh -h` for details)
+    generates individual parts.
 
 For a single cubby, you will need to print the side piece twice, and the bottom
 piece once. To add additional cubbies, print one bottom and one side. The bottom
@@ -68,6 +73,66 @@ by specifying either `male_tabs` or `female_tabs` for the `part` paramaters (the
 `cubby_depth` paramater is respected as the length of those dovetail test
 pieces).
 
+## Parameters ##
+
+`part` Controls which part will be generated, and can be any of:
+
+: `bottom` — a bottom part whose dimensions will be `cubby_width` x `cubby_depth`.
+
+: `side` — a side part whose dimensions will be `cubby_depth` x `cubby_height`.
+
+: `both` — a `bottom` and a `side` laid next each other. (These may look like
+  two seperate models, but is only one model, and obnixious to work with in a
+  slicer. Generating them seperately will allow you to manipulate them
+  individually).
+
+: `female_tabs` — generates a shape consisting of the minimum amount of material
+  needed to test the dovetail joint fit. `cubby_depth` is respected as the
+  length that the tab holes (mortises) should run. (I have found that although
+  my printer could print a single tab accurately, spanning the entire length of
+  `cubby_depth` gave me the most accurate test.
+
+: `male_tabs` — as `female_tabs` above, except with male tabs (tenons)
+
+: `view_fit` — used as a debugging aid during development -- displays two sets
+  of tops and bottoms posiitioned to inspect tab fit.
+
+### Cubby Dimensions ###
+
+`cubby_width`
+: How wide the cubby should be, used as one dimension of the `bottom` and `male_tabs` `part`.
+
+`cubby_depth`
+: How deep the cubby should be, used as one dimension of the `side` and `female_tabs` `part`.
+
+`cubby_height`
+: How deep the cubby should be, used as one dimension of the `side`.
+
+`thickness`
+: How thick the `bottom`, `side`, or test fit pieces (`male_tabs`,
+  `female_tabs`) should be. When either part is eventually laid flat on the
+  print bed, this effectively becomes the `z` axis height. (The `tab_depth` is
+  dictated by this `thickness` dimension.)
+
+`strut_thickness`
+: The thickness of the strut members in the sparse structures. Applies to both
+  `bottom` and `side`.
+
+`max_bridge`
+: Maximum bridging distance between cross-braces of sparse struts. Applies to
+  `bottom`, and `side`.
+  
+### Tab/Dovetail Dimensions ###  
+
+`tab_width`
+: The width of each tab.
+
+`tab_padding`
+: The distance of the first tab from the edge, as well as between each tab.
+
+`tab_tolerance`
+: How much bigger the hole (or mortise) should be than the tab (tenon)
+
 ![[Dovetail Test Fit](pictures/dovetail_test_fit.jpg-full "Dovetail Test Fit (full resolution)")](pictures/dovetail_test_fit-thumbnail.jpg)
 
 ## Source Repository ##
@@ -119,7 +184,7 @@ pieces).
 
 ## Contributions ##
 
-![](pictures/kenneth-copeland.jpg) ![](pictures/basket.jpg)
+![Megachurch Pastor](pictures/kenneth-copeland.jpg) ![Donation Basket](pictures/basket.jpg)
 
 
 - PayPal: <https://paypal.me/svasilogianis>