add documentatoin

1 files changed, 25 insertions, 0 deletions

diff --git a/shopenscad.sh b/shopenscad.sh
index 7515afe..4e3de98 100755
--- a/shopenscad.sh
+++ b/shopenscad.sh
@@ -1,6 +1,31 @@
 #!/bin/bash
 # parse a .scad file and generate an openscad command with all its var=value's
 # parameterized into -D options, which can be overriden with shell variables.
+#
+# Usage examples:
+#
+# $ ./shopenscad.sh cubbies.scad
+# openscad 'cubbies.scad' -D 'part="divider"' -D 'cubby_width=50' -D 'cubby_depth=180' -D 'cubby_divider_height=90' -D 'thickness=5' -D 'strut_thickness=5' -D 'tab_width=10' -D 'tab_padding=5' -D 'tab_tolerance=0.5'  -o 'divider=50=180=90=5=5=10=5=0.5.stl'
+# [openscad output omitted]
+#
+# (the openscad command is printed and then evaluated, outputing to the file
+# indicated after the -o flag)
+#
+# You can also overwrite the variables parsed from your scad file by passing a
+# shell variable with the same name:
+#
+# $ cubby_width=200 part=\"bottom\" ./shopenscad.sh cubbies.scad
+# openscad 'cubbies.scad' -D 'part="bottom"' -D 'cubby_width=200' -D 'cubby_depth=180' -D 'cubby_divider_height=90' -D 'thickness=5' -D 'strut_thickness=5' -D 'tab_width=10' -D 'tab_padding=5' -D 'tab_tolerance=0.5'  -o 'bottom=200=180=90=5=5=10=5=0.5.stl'
+# [openscad output omitted]
+#
+# Now we can easily generate multiple models:
+#
+# $ for w in 250 300 350 400; do
+# >     for p in '"divider"' '"bottom"'; do
+# >         cubby_width="$w" part="$p" ./shopenscad.sh  cubbies.scad
+# >     done
+# > done
+# [openscad output omitted]
 
 openscad=${OPENSCAD:-"openscad"}