From ae43aaa05fb17455717c95261375cbb93f1bc785 Mon Sep 17 00:00:00 2001 From: Bob Date: Fri, 29 Dec 2017 00:53:01 -0500 Subject: [PATCH] add image references in README --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e9437a..8b51af5 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ Every key starts with defaults that are overridden by each function call. The si ``` cherry() key() ``` +![a bog-standard cherry key](assets/example1.JPG) + + which is a bog-standard DCS row 5 keycap. To change key profile or make varying width keys, you can use the row and unit length functions, like so: @@ -22,6 +25,7 @@ which is a bog-standard DCS row 5 keycap. To change key profile or make varying sa_row(2) u(2) cherry() key(); ``` +![a 2 unit SA row 2 cherry key](assets/example2.JPG) ## What if I want to customize my keycaps? @@ -36,6 +40,8 @@ for(y=[0:3]) { } ``` +![a set of 2 unit keys with legends](assets/example3.JPG) + The `key()` function also supports children, and will place them in the center of the top of the keycap, if you want to quickly design your own artisan keycaps: ``` @@ -44,6 +50,8 @@ cherry() key() { }; ``` +![an artisan key with no-face on it](assets/example4.JPG) + ## What if I want to get _really_ technical? If you're not afraid to write some code yourself, at the base level this library _should_ function well as a key profile design library. by loading up `src/key.scad` (notice no s) you can tweak variables in `src/settings.scad` to prototype your own profiles. You can design your own keyset with custom width height and depth, dish tilt, top skew, fonts, wall thickness, etc. @@ -79,7 +87,9 @@ union() { } ``` -## I'm not getting good prints... +![three stop-sign shaped keys with legends](assets/example5.JPG) + +## Printing Help Prints from this library are still challenging, despite all efforts to the contrary. Resin printers can create great looking keycaps; FDM printers can create usable keys that look alright, but may require tweaking to get prints acceptable. There are a few quick things that you can do: