diff options
author | Steven <steven.vasilogianis@gmail.com> | 2022-03-18 16:17:26 -0400 |
---|---|---|
committer | Steven <steven.vasilogianis@gmail.com> | 2022-03-18 16:18:30 -0400 |
commit | 91490990e52906e13db9606050d6a7167c1e7d13 (patch) | |
tree | 51733ef48c6d8d866a47e6f008e87400e2e0288b | |
parent | 6180816b2080fb792e909fd3cb6eccb8b80b9578 (diff) |
add quickstart section
-rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
@@ -17,6 +17,46 @@ optimized for printing by using [sparse | |||
17 | structures](https://github.com/revarbat/BOSL2/wiki/walls.scad#module-sparse_strut) | 17 | structures](https://github.com/revarbat/BOSL2/wiki/walls.scad#module-sparse_strut) |
18 | (to save material) that lay flat on the print bed (for ease of printing). | 18 | (to save material) that lay flat on the print bed (for ease of printing). |
19 | 19 | ||
20 | ## Quick Start ## | ||
21 | |||
22 | This is how I would use this software: | ||
23 | |||
24 | ### Generate From Console ### | ||
25 | |||
26 | ```shell | ||
27 | ~/tmp$ git clone --recurse-submodules https://git.cryptonomic.net/cubbies.git | ||
28 | ~/tmp$ cd cubbies | ||
29 | ~/tmp/cubbies$ ./cubbies.sh 164 94 34 | ||
30 | ~/tmp/cubbies$ Ultimaker_Cura-4.10.0.AppImage $(pwd)/*.stl | ||
31 | ``` | ||
32 | |||
33 | I omitted the output of the commands, but the cubies.sh script generated two stl | ||
34 | files: bottom-34-164-94-5-5-0-10-5-0.5-true.stl and | ||
35 | side-34-164-94-5-5-0-10-5-0.5-true.stl, then opened in Cura (my slicer). | ||
36 | |||
37 | ### Generate with OpenSCAD customizer ### | ||
38 | |||
39 | |||
40 | You can also generate models using the OpenSCAD's builtin customizer: | ||
41 | |||
42 | ```shell | ||
43 | ~/tmp$ git clone --recurse-submodules https://git.cryptonomic.net/cubbies.git | ||
44 | [snip git clone output] | ||
45 | ~/tmp$ cd cubbies | ||
46 | ~/tmp/cubbies$ OpenSCAD-2021.04.13.ai7733-2021.04.13.ai7733-x86_64.AppImage cubbies.scad | ||
47 | ``` | ||
48 | |||
49 | In the last line, you may need to replace the | ||
50 | OpenSCAD-2021.04.13.ai7733-2021.04.13.ai7733-x86_64.AppImage with wherever the | ||
51 | OpenSCAD executable is on your system. Once you're in OpenSCAD, if you do not | ||
52 | have the customizer panel, on the top menu bar choose Window, and Hide | ||
53 | Customizer should appear without a check (`[ ] Hide Customzer`) | ||
54 | |||
55 | ### Thingiverse Customizer ### | ||
56 | |||
57 | It also works in the thingiverse customizer, however, if you go that route there | ||
58 | is a wait time to get your models. | ||
59 | |||
20 | ## Pictures ## | 60 | ## Pictures ## |
21 | 61 | ||
22 | ::: { .figs } | 62 | ::: { .figs } |