From 91490990e52906e13db9606050d6a7167c1e7d13 Mon Sep 17 00:00:00 2001 From: Steven Date: Fri, 18 Mar 2022 16:17:26 -0400 Subject: add quickstart section --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index ccfbbe7..e926e00 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,46 @@ optimized for printing by using [sparse structures](https://github.com/revarbat/BOSL2/wiki/walls.scad#module-sparse_strut) (to save material) that lay flat on the print bed (for ease of printing). +## Quick Start ## + +This is how I would use this software: + +### Generate From Console ### + +```shell +~/tmp$ git clone --recurse-submodules https://git.cryptonomic.net/cubbies.git +~/tmp$ cd cubbies +~/tmp/cubbies$ ./cubbies.sh 164 94 34 +~/tmp/cubbies$ Ultimaker_Cura-4.10.0.AppImage $(pwd)/*.stl +``` + +I omitted the output of the commands, but the cubies.sh script generated two stl +files: bottom-34-164-94-5-5-0-10-5-0.5-true.stl and +side-34-164-94-5-5-0-10-5-0.5-true.stl, then opened in Cura (my slicer). + +### Generate with OpenSCAD customizer ### + + +You can also generate models using the OpenSCAD's builtin customizer: + +```shell +~/tmp$ git clone --recurse-submodules https://git.cryptonomic.net/cubbies.git +[snip git clone output] +~/tmp$ cd cubbies +~/tmp/cubbies$ OpenSCAD-2021.04.13.ai7733-2021.04.13.ai7733-x86_64.AppImage cubbies.scad +``` + +In the last line, you may need to replace the +OpenSCAD-2021.04.13.ai7733-2021.04.13.ai7733-x86_64.AppImage with wherever the +OpenSCAD executable is on your system. Once you're in OpenSCAD, if you do not +have the customizer panel, on the top menu bar choose Window, and Hide +Customizer should appear without a check (`[ ] Hide Customzer`) + +### Thingiverse Customizer ### + +It also works in the thingiverse customizer, however, if you go that route there +is a wait time to get your models. + ## Pictures ## ::: { .figs } -- cgit v1.2.3