documentation and usage

1 files changed, 29 insertions, 8 deletions

diff --git a/cubbies.sh b/cubbies.sh
index 10c92f6..925b822 100755
--- a/cubbies.sh
+++ b/cubbies.sh
@@ -1,14 +1,35 @@
 #!/bin/bash
+# this script started off generated using shopenscad.sh -s cubbies.scad
 
 usage() {
     cat <<EOF
-    $0 cubby-depth cubby-height cubby-width0 cubby-width1 cubby-widthN
-    e.g.:
-    $0 150 90 20 30 35
+$0 cubby-depth cubby-height cubby-width1 [cubby-width2 ... cubby-widthN]
+
+Examples:
+
+    $0 150 90 20
+
+    Generates two total pieces: a side piece (150mm depth, 90mm height) and a
+    bottom piece (150mm depth and 20mm width).
+
+    You will need to print the side piece twice and bottom piece once.
+
+    $0 180 120 20 30 35
+
+    Generates four total pieces, which can be assembled to form a row of
+    cubbies: one side piece (180mm depth, 120mm height) and three bottom pieces,
+    with widths of 20mm, 30mm, and 35mm (and each sharing the same depth of
+    180mm).
+
+    You will need to side piece twice for the first bottom piece, then
+    a single side piece for each additional bottom piece.
 EOF
 }
 
 [ "-h" == "$1" ] && usage && exit;
+if [ "$#" -lt 3 ]; then
+    echo "$0: Needs atleast three paramaters. See usage:"; usage; exit 1;
+fi;
 
 shopenscad_cmd="./shopenscad.sh cubbies.scad "
 
@@ -17,11 +38,11 @@ export $(echo $($shopenscad_cmd -p))
 # tab_padding=5
 # tab_width=10
 # max_bridge=0
-# # cubby_width=150
-# # cubby_depth=120
+# cubby_width=150
+# cubby_depth=120
 # strut_thickness=5
 # screw_tabs=true
-# # cubby_height=90
+# cubby_height=90
 # #part="both"
 # thickness=3
 # tab_tolerance=0.5
@@ -29,10 +50,10 @@ export $(echo $($shopenscad_cmd -p))
 cubby_depth=$1; shift
 cubby_height=$1; shift
 
-# echo depth: $cubby_depth
-# echo height: $cubby_height
+# generate the single side piece
 part='"side"' ${shopenscad_cmd}
 
+# generate each bottom piece
 for i in "$@"; do
     part='"bottom"' cubby_width="$i" ${shopenscad_cmd}
 done;