diff options
Diffstat (limited to 'keyboards/kyria/keymaps/pierrec83/readme.md')
| -rw-r--r-- | keyboards/kyria/keymaps/pierrec83/readme.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/keyboards/kyria/keymaps/pierrec83/readme.md b/keyboards/kyria/keymaps/pierrec83/readme.md new file mode 100644 index 0000000000..fae22f8366 --- /dev/null +++ b/keyboards/kyria/keymaps/pierrec83/readme.md @@ -0,0 +1,44 @@ +@pierrec83's keymap for the Kyria +=== + +A comfortable for me using 34 keys. + +This keymap has evolved over a period of time from iterating as I observed pain points in my interacting with my home and work computers (MacOS and Linux. I edited many of the shortcuts in MacOS to match those in Linux for consistency). + +Features +--- +* Mouse keys with constants tuned so the keyboard usable for me as my sole pointing device +* Homerow layers activation +* Minimal unhoming of the thumbs (the one side thumb key I do use does not overlap with typing english or code) +* Minimal side-index motion thanks to workman base layer and similar principles in other layers +* Two symbol layers, both activated with one homerow key and either another key on the same hand's homerow or a key from the other hand +* Mousing around, including left and right clicking can be done either one-handed or fully on the homerow with both hands +* Easy chaining of common command line or vim patterns, such as `~/`, `()`, `ESC : w ENTER` etc. +* Outer pinky columns unused for ergonomic reasons +* Common OS shortcuts like switching workspaces on gnome or MacOS easily accessible (for the shortcuts I use. This may not apply to others) + +Instructions to update the keymap +--- + +For now, I am still more comfortable updating the keymap through the qmk configurator as I don't trust myself to manually keep comments describing the keymap in sync with the code itself. This means that my keymap.c is generated and not really readable. For a readble view of my keymap, one must import keymap.json into [qmk configurator](https://config.qmk.fm) and use the web UI or print it. + +To update the keymap, +* Load keymap.json into qmk configurator +* Perform any edits +* Export the keymap. This should save a json file in `~/Downloads/pierrec83.json` or equivalent for your OS +* From the root of qmk_firmware, move the keymap to its destination: +``` +mv ~/Downloads/pierrec83.json keyboards/kyria/keymaps/pierrec83/keymap.json +``` +* Regenerate the `keymap.c`: +``` +qmk json2c keyboards/kyria/keymaps/pierrec83/keymap.json -o keyboards/kyria/keymaps/pierrec83/keymap.c +``` +* Flash the firmware (for instance, if left hand is plugged): +``` +qmk flash -kb kyria -km pierrec83 -bl dfu-split-left +``` + +Author +--- +I am @pierrec83 on Twitter, @pierrechevalier83 on github. I chose the shorter nickname for my keymap. |