initial readme

1 files changed, 66 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f6720a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+Copyright (C) Steven Vasilogianis
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+# Summary #
+
+3D printable parametric cubbies to store your shit. There are two distinct parts
+-- a "bottom" and a "side" -- that can be generated to the dimensions you need.
+
+# Instructions #
+
+**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:
+
+   *) Using the Thingiverse Customizer
+
+   *) Using Openscad -- either by using its builtin customizer (choose
+      Window->Customizer from the menu bar if it is not visible), or by
+      modifying the variabels at the top of the cubbies.scad file.
+
+   *) Using either the included shopenscad.sh script (run "shopenscad.sh -h" for
+      details) to generate a single model, or cubbies.sh (run "cubbies.sh -h"
+      for details) if you want to generate an entire set of cubbies.
+
+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
+and side pieces can be flipped upside down so that the bottom pieces tenons fit
+into the mortises of the side piece that are not in use by its adjacent bottom
+piece.
+
+You can print tolerance test fit pieces (which are the minimum material
+necessary to confirm that the pieces will fit with your printer and slicer
+settings). These test pieces were generated using dovetail_test_fits.sh, which
+you can use to generate your own at different tolerances. You can also generate
+them in OpenSCAD by specifying either "male_tabs" and "female_tabs" for the
+"part" variable. (The cubby_depth paramater is respected as the length of those
+dovetail test pieces).
+
+# Contributions #
+
+I could use sum $ rn:
+
+  Paypal: https://paypal.me/svasilogianis
+  Venmo: https://venmo.com/u/Steven-Vasilogianis
+  Cashapp: https://cash.app/$svasi
+
+# Dependencies/Credits #
+
+  OpenSCAD: https://openscad.org
+  Belfry OpenScad Library: https://github.com/revarbat/BOSL2
+
+# Links: #
+
+  Git repisotiroy for this project: (the latest version of this software will
+  always be available here): https://git.cryptonomic.net/cubbies.git/
+
+  thingiverse
+  thangs
+  cults3d
+  cadhub.xyz