keyboards/ergodox/keymaps/pvinis/Readme.md

   1 pvinis' keymap
   2 ==============
   3
   4 This is a getting-used-to keymap for the [ErgoDox EZ][ez]. It's very much a work in progress.
   5
   6 [ez]: https://ergodox-ez.com/
   7
   8 ## Table of Contents
   9
  10 * [Todo](#todo)
  11 * [Layouts](#layouts)
  12   - [Base layer](#base-layer)
  13   - [Beginner layer](#beginner-layer)
  14   - [QWERTY layer](#qwerty-layer)
  15   - [CARPALX layer](#carpalx-layer)
  16   - [System Control layer](#system-control-layer)
  17   - [Template layers](#template-layers)
  18 * [Building](#building)
  19
  20 # Todo
  21
  22 - [ ] Generate images from keymap
  23 - [ ] Implement algernon's heatmap
  24 - [ ] Implement `KC_POP`
  25
  26 # Layouts
  27
  28 ## Base layer
  29
  30 This is the base layer that contains the common buttons of all keymaps. Right now, it has the top left button as a `flash` button when it's tapped 4 times, and the two thumb islands. The islands contain the `space` and `enter` keys on the right, the `backspace` and `shift` on the left, and all the 1x1 keys are just layer switches.
  31 Every time I connect the keyboard, I press the `BEGIN` layer switch, and then start typing.
  32 Recently, I added a few application "shortcuts", that basically call `ctrl`+`alt`+`cmd`+`<key>`, and `<key>` is `S` for Slack, `X` for Xcode, `M` for Messenger. Using [Hammerspoon][hammerspoon], I show/hide the application.
  33
  34 [hammerspoon]: http://www.hammerspoon.org/
  35
  36 ## Beginner layer
  37
  38 This is a basic keymap I use right now until I'm comfortable typing on the Ergodox. Currently uses a QWERTY layout, and the `([{}])` on the middle keys. Not a perfect layout, and its going to go away at some point, but for now thats my daily driver.
  39
  40 ## QWERTY layer
  41
  42 This is basically the same as the `BEGIN` layer, but it might go away. I'm not using it, but I should have a QWERTY layout on the keyboard, in case someone else wants to try it out, or if I completely forget how keyboards work! At some point, this and the `BEGIN` layer will become one.
  43
  44 ## CARPALX layer
  45
  46 This is here as a placeholder. I want to transition to [Carpalx QGMLWY][carpalx] or [White][white] at some point. They both look very interesting and more comfortable to type on, but after I'm confident with typing on the Ergodox.
  47
  48 [carpalx]: http://mkweb.bcgsc.ca/carpalx/?full_optimization
  49 [white]: https://github.com/mw8/white_keyboard_layout
  50
  51 ## System Control layer
  52
  53 This one is a layer that, in time, will have controls like mouse movement, volume up/down, mute, sleep, restart, shutdown, etc.
  54
  55 ## Template layers
  56
  57 I have two commented out layers that are just templates, so I can easily create a new layer.
  58
  59 # Building
  60
  61 ```
  62 $ git clone https://github.com/qmk/qmk_firmware.git
  63 $ cd qmk_firmware/keyboards/ergodox/keymaps/pvinis
  64 $ make
  65 ```