changed the contents

1 files changed, 110 insertions, 40 deletions

diff --git a/README.md b/README.md
index 005c867..cc692ae 100644
--- a/README.md
+++ b/README.md
@@ -1,68 +1,138 @@
-Copyright (C) Steven Vasilogianis
+# 3D Printable Parametric Cubbies #
+
+::: { .parts }
+
+Bottom Part:
+: [![Bottom Part](pictures/bottom.jpg "Bottom part"){#fig:bottom}](pictures/darktable_exported/full/IMG_4679_01.jpg)
+
+Side Part:
+: [![Side](pictures/side.jpg "Side part"){#fig:side}](pictures/darktable_exported/full/IMG_4679.jpg)
+
+:::
+
+3D printable parametric cubbies to store your 3D things. There are two distinct
+parts -- a `bottom` and a `side` -- that are generated to the dimensions of your
+things, then 3D printed and assembled into modular storage units.
+
+## Pictures ##
+
+::: { .figs }
+
+![[Bottom part (printed)](pictures/darktable_exported/full/IMG_4679_01.jpg "Bottom part, printed (full resolution)")](pictures/darktable_exported/250px/IMG_4679_01.jpg)
+
+![[Side part (printed)](pictures/darktable_exported/full/IMG_4679.jpg "Side part, printed (full resolution)")](pictures/darktable_exported/250px/IMG_4679.jpg "Side part, printed")
+
+![[The Smurftruder with a fresh print](pictures/darktable_exported/full/20211110_0060_01.jpg "Smurfstrusion (full resolution)")](pictures/darktable_exported/250px/20211110_0060_01.jpg)
+
+![[Mounted Cubbies (empty)](pictures/darktable_exported/full/IMG_4720.jpg "Mounted Cubbies (full resolution)")](pictures/darktable_exported/250px/IMG_4720.jpg)
+
+![[Mounted Cubbies (empty, viewed from an angle)](pictures/darktable_exported/full/IMG_4727.jpg "Empty cubbies, mounted (full resolution)")](pictures/darktable_exported/250px/IMG_4727.jpg)
 
-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.
+![[Mounted Cubbies (filled)](pictures/darktable_exported/full/IMG_4717.jpg "Mounted cubbies, filled (full resolution)")](pictures/darktable_exported/250px/IMG_4717.jpg)
 
-# Summary #
+![[Cubby Development](pictures/darktable_exported/full/IMG_4708.jpg "Cubby Development (full resolution)")](pictures/darktable_exported/250px/IMG_4708.jpg)
 
-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.
+<!-- ![My Caption](pics/my-pic.jpg "My Pic") -->
 
-# Instructions #
+::: 
 
-**DO NOT SCALE IN A SLICER**
+## Instructions ##
 
-Your distribution of this project may have included stl files; these are either
+### 🚫 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 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 `Openscad` -- either by using its builtin customizer (choose
+    `Window -> Customizer` from the menu bar if it is not visible), or by
+    modifying the variables at the top of the `cubbies.scad` file.
 
-   *) I wanted an automated way to create sets of of cubbies, so there are two
-      scripts: shopenscad.sh (run "shopenscad.sh -h" for details) generates a
-      single model, and cubbies.sh (run "cubbies.sh -h" for details) can
-      generate entire sets of cubbies.
+  * There are two scripts for generating cubbies from the commandline:
+    `shopenscad.sh` (run `./shopenscad.sh -h` for details) generates a single
+    model, and `cubbies.sh` (run `./cubbies.sh -h` for details) can generate
+    entire sets 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 tabs fit
+and side pieces can be flipped upside down so that the bottom piece's tabs fit
 into the extra unused holes of the side piece. You can also use this to control
 whether the screw tabs end up on the inside or outside of the cubby.
 
 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
+settings). These test pieces were generated using `dovetail_test_fits.sh`, which
 you can use to generate your own at different tolerances (run
-"dovetail_test_fits.sh -h" for details). 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).
+`dovetail_test_fits.sh -h` for details). You can also generate them in `OpenSCAD`
+by specifying either `male_tabs` or `female_tabs` for the `part` paramaters (the
+`cubby_depth` paramater is respected as the length of those dovetail test
+pieces).
+
+![[Dovetail Test Fit](pictures/darktable_exported/full/20211112_0004.jpg "Dovetail Test Fit (full resolution)")](pictures/darktable_exported/250px/20211112_0004.jpg)
+
+## Source Repository ##
+
+  The source repository is a Git repository that is hosted both on a read-only
+  HTTPS URL and on a read-write SSH url. 
+  
+  You can push to the read-write URL simply without creating any user account.
+  You only need to generate a SSH public key on your own system.
+
+### Read-Only Clone ###
+
+  The read-only clone command is:
 
-# Contributions #
+    git clone --recurse-submodules https://git.cryptonomic.net/cubbies.git
+  
+### Read-Write Clone ###
 
-I could use sum $ rn:
+  To clone from the read-write URL, you first need to have your own ssh identity.
+  Then you can run `git clone`.
+  
+    # Generate an SSH key if needed
+    command -v ssh-keygen || { echo Please Install OpenSSH; exit; }
+    [ -d ~/.ssh ] || mkdir ~/.ssh
+    [ -e ~/.ssh/id_ed25519.pub ] || ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -N 
+    
+    # Add the public key for cryptonomic.net
+    echo cryptonomic.net ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPK7K8KsygvXtjw0yH4h43bwBGKq9oWBdCa1eY5rzT5D >> ~/.ssh/known_hosts 
 
-  Paypal: https://paypal.me/svasilogianis
-  Venmo: https://venmo.com/u/Steven-Vasilogianis
-  Cashapp: https://cash.app/$svasi
+    # Perform the clone
+    git clone --recurse-submodules ssh://d@cryptonomic.net:public_git/cubbies.git
+    
+  You can push your changes back simply:
+  
+    git add .
+    git commit -a -m 'commit message'
+    git push
 
-# Dependencies/Credits #
+## Cubbies on the Web ##
 
-  OpenSCAD: https://openscad.org
-  Belfry OpenScad Library: https://github.com/revarbat/BOSL2
+  * thingiverse
+  * thangs
+  * cults3d
+  
+## Dependencies/Credits ##
 
-# Links: #
+  * [OpenSCAD](https://openscad.org "OpenSCAD")
+  * [Belfry OpenSCAD Library](https://github.com/revarbat/BOSL "Belfry OpenSCAD Library")
+
+## Contributions ##
+
+I could use sum __$__ rn
+
+- [Paypal](https://paypal.me/svasilogianis)
+- [Venmo](https://venmo.com/u/Steven-Vasilogianis)
+- [Cashapp](https://cash.app/$svasi)
+
+## GPLv3 License ##
+
+Copyright (C) Steven Vasilogianis
 
-  Git repisotiroy for this project: (the latest version of this software will
-  always be available here): https://git.cryptonomic.net/cubbies.git/
-  git clone d@cryptonomic.net:public_git/cubbies.git
+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.
 
-  thingiverse
-  thangs
-  cults3d
-  cadhub.xyz