From 2fbc7fe1037356f2eddaff4b5ed6abc8566a83fa Mon Sep 17 00:00:00 2001 From: Jason Cemra Date: Tue, 13 Dec 2016 12:15:34 +1100 Subject: [PATCH] Updated formatting of README and CONVENTIONS (Version 0.2.0) --- CONVENTIONS.md | 6 ++++-- README.md | 38 +++++++++++++++++++++++++++----------- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/CONVENTIONS.md b/CONVENTIONS.md index 9841c19..f40c2fc 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -26,7 +26,9 @@ standard names that are to be used for consistencies sake. ## Model Names -This project is based around Inventor iParts (factory parts) in order to reduce workload in the event of modifications. As such, all four keycap variants (standard, large, small and thumb) are contained in a single file. +This project is based around Inventor iParts (factory parts) in order to reduce +workload in the event of modifications. As such, all four keycap variants +(standard, large, small and thumb) are contained in a single file. These files should be named: @@ -79,4 +81,4 @@ For example: * `base`, `flat` and `curved` types are called "Flavors". * `standard`, `small`, `large` and `thumb` are called "Variants". * `solid` and `backlit` are called "Base types". -* Given the correct context, the word "Type" may be used for any of the above. \ No newline at end of file +* Given the correct context, the word "Type" may be used for any of the above. diff --git a/README.md b/README.md index 4778c99..37670cd 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ### WORK IN PROGRESS - RECOMMEND NOT USING YET > Convert your keyboard into a stenotype. -> *Version 0.1.0* +> *Version 0.2.0* @@ -18,16 +18,16 @@ or [Blender][blender]). This branch (master) contains the design files for Note that StenoToppers are designed for use with a mechanical keyboard that supports [N-key rollover (NKRO)][nkey], alongside the fantastic open source -[Plover][plover] software. If you're interested in learning more about *typing +[Plover][plover] software. If you're interested in learning more about *typing at the speed of thought*, see the [Plover Blog][plover-blog]. -**If it all seems too hard:**
3D model and printing work is currently -fiddly and time consuming. If you want a quicker solution that is guaranteed -to work on any steno-ready keyboard, then we heartily recommend the [Laser-Cut +**If it all seems too hard:**
3D model and printing work is currently fiddly +and time consuming. If you want a quicker solution that is guaranteed to work on +any steno-ready keyboard, then we heartily recommend the [Laser-Cut Keytoppers][keytoppers] ($20 USD + $Shipping) from the [Plover Store][plover-store][1](#not-a-sponsor). These are secured to -existing keycaps with some sturdy "adhesive foam" and are reportedly easy to -set up. +existing keycaps with some sturdy "adhesive foam" and are reportedly easy to set +up. Anyway, on with the show. @@ -40,7 +40,8 @@ keyboard into a stenotype look-alike. They are designed to be customized to fit any keyboard with Cherry MX keyswitches or any "identical" Cherry MX variant. -The whole point of these keycaps is to slightly raise, compact and align the top two rows of keys (making it easier to chord them) and move the thumb-keys +The whole point of these keycaps is to slightly raise, compact and align the top +two rows of keys (making it easier to chord them) and move the thumb-keys comfortably above the space-bar and into a more ergonomic position. Without StenoToppers, it is harder to press two keys with one finger and thumbs can become *very* sore - not helped when trying to avoid the spacebar all the time. @@ -50,13 +51,24 @@ become *very* sore - not helped when trying to avoid the spacebar all the time. ### A Note on Key Spacing -Notice how StenoToppers make the keys look a fair bit wider than normal keycaps. This is because StenoToppers utilize almost the entire keycap base to allow multiple keys to be pressed at once. On a QWERTY keyboard, this function is often undesirable, so keycaps heavily taper off to provide space around them - too much space for speedy stenography. This is why the StenoToppers look slightly larger than normal keycaps, while still retaining the same spacing *around* them. +Notice how StenoToppers make the keys look a fair bit wider than normal keycaps. +This is because StenoToppers utilize almost the entire keycap base to allow +multiple keys to be pressed at once. On a QWERTY keyboard, this function is +often undesirable, so keycaps heavily taper off to provide space around them - +too much space for speedy stenography. This is why the StenoToppers look +slightly larger than normal keycaps, while still retaining the same spacing +*around* them. ![demo-stenotopper-closeup-image](link) ### Types of StenoToppers -Note that there are *four* variants of the keycap: standard, large, small and thumb. The standard keycaps are in majority, and line up most of the top row's keys. The small and large variants are meant to go on the end of each row (in the right spot) so the rows match up with existing keys (like enter and tab). These are required so the end of each row fits, but if the keyboard is empty anyway, they are optional. +Note that there are *four* variants of the keycap: standard, large, small and +thumb. The standard keycaps are in majority, and line up most of the top row's +keys. The small and large variants are meant to go on the end of each row (in +the right spot) so the rows match up with existing keys (like enter and tab). +These are required so the end of each row fits, but if the keyboard is empty +anyway, they are optional. The StenoToppers come in two flavors - flat or curved: @@ -133,7 +145,11 @@ accept Inventor files for printing. Need a printing guide and checklist here. Also, a section on various services. -When you print them, make sure you're printing the "flat" or "curved" models. The standard model is the common base that defines key dimensions - it does not have any aesthetic embellishments *or* (most importantly) and 3D printing optimizations. The Standard keycap would nominally take 80% longer to print than, say, the flat design. +When you print them, make sure you're printing the "flat" or "curved" models. +The standard model is the common base that defines key dimensions - it does not +have any aesthetic embellishments *or* (most importantly) and 3D printing +optimizations. The Standard keycap would nominally take 80% longer to print +than, say, the flat design. ### Minimum 3D Printer Specs