diff options
Diffstat (limited to 'keyboards/keebio/levinson/keymaps/dcompact/readme.md')
| -rw-r--r-- | keyboards/keebio/levinson/keymaps/dcompact/readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/keyboards/keebio/levinson/keymaps/dcompact/readme.md b/keyboards/keebio/levinson/keymaps/dcompact/readme.md new file mode 100644 index 000000000..cd88c3fed --- /dev/null +++ b/keyboards/keebio/levinson/keymaps/dcompact/readme.md | |||
| @@ -0,0 +1,45 @@ | |||
| 1 | # DCompact Layout | ||
| 2 | |||
| 3 | **Dvorak, Layered, Mouse-Enabled, Compact -- now with Plover~** | ||
| 4 | |||
| 5 | _See [the layout source](keymap.c) for the actual layout_ | ||
| 6 | |||
| 7 | ## Goals | ||
| 8 | |||
| 9 | The following are the goals kept in mind when designing the DCompact | ||
| 10 | layout: | ||
| 11 | |||
| 12 | - Provide minimal travel distance when typing English or coding | ||
| 13 | - Consistent muscle memory translation from standard QWERTY | ||
| 14 | - Stateless typing experience | ||
| 15 | - OS-agnostic features, macros, and key placement | ||
| 16 | - Minimize dependence on mouse usage | ||
| 17 | |||
| 18 | These are generally all met or balanced within reason. This layout is | ||
| 19 | not intended at all to be a familiar layout for much of anyone (except | ||
| 20 | maybe those who already type in Dvorak) -- this is meant to amplify the | ||
| 21 | best parts of having limited, ortholinear keys with layering. | ||
| 22 | |||
| 23 | ## As Reference Material | ||
| 24 | |||
| 25 | If you're reading this hoping to find reference material to implement | ||
| 26 | your own layout, then please feel free to copy over this layout and | ||
| 27 | make edits where you see fit. I removed a lot of the features I felt | ||
| 28 | extraneous to my usage and simplified style where I felt needed. This | ||
| 29 | would hopefully mean that my code should feel like a good base to | ||
| 30 | develop from for those new to QMK. | ||
| 31 | |||
| 32 | _Remember that settings defined in the layout directory override and | ||
| 33 | merge with those in the keyboard folder_ | ||
| 34 | |||
| 35 | ## Relevant Links | ||
| 36 | |||
| 37 | - [Online Dvorak Layout Trainer](https://learn.dvorak.nl/) | ||
| 38 | - [Dvorak Wikipedia Page](https://en.wikipedia.org/wiki/Dvorak_Simplified_Keyboard) | ||
| 39 | - [QMK Docs](https://docs.qmk.fm/#/) | ||
| 40 | - [QMK KeyCode Reference](https://docs.qmk.fm/#/keycodes) | ||
| 41 | |||
| 42 | ## Contact | ||
| 43 | |||
| 44 | Maintainer: [Dan](https://github.com/loksonarius) | ||
| 45 | |||
