keyboards/ergodox/keymaps/narze/readme.md

   1 # narze's layout
   2
   3 ## Notes
   4 - SuperDuper mode for Ergodox is still under development, since combo keys does not work very well on Ergodox firmware.
   5   Now it is using multiple layers as a workaround. Actual implementation using combos are on my Planck layout.
   6
   7 ## Key features
   8 - Qwerty + [Colemak](https://colemak.com) layouts, and you can type Qwerty on software-level Colemak as well. Very useful for gaming or when your friend wanna type something but don't use Colemak.
   9 - [(S)uper (D)uper Mode](https://github.com/jasonrudolph/keyboard#super-duper-mode) inspired by [jasonrudolph](https://github.com/jasonrudolph), with [some extensions](https://gist.github.com/narze/861e2167784842d38771) such as backspace & forward delete.
  10 - Mouse keys with Z
  11
  12 ## (S)uper (D)uper Mode
  13 Press `S+D` simultaneously and hold, then...
  14 - `H/J/K/L` for Vim-like movement
  15 - `I/O` to move between browser tabs (Not working on Windows yet)
  16 - `A` for `Option (Alt)`
  17 - `F/;` for `Backspace/Forward delete`
  18 - `A` with `H/L` to move to previous/next word
  19 - `A` with `G/;` to delete to previous/next word
  20 - `G` for `Cmd` (Gui/Windows)
  21 - Available for all layouts (but plover) using physical S & D keys position in qwerty
  22 - `Spacebar` for `Shift` (it's easier when already holding A with your pinky)
  23 - Disable with `Raise+Lower+M`
  24 - You can edit or add more useful keys in SUPERDUPER layer
  25 - It can be activated by holding `/` as well, but it's slower since `LT()` uses `TAPPING_TERM` of 200ms but `S+D` uses `COMBO_TERM` of only 20ms (Can be changed within config.h)
  26
  27 ## Build instructions
  28 - `cd /path/to/qmk_firmware`
  29
  30 #### Left side
  31  ```
  32 docker run -e keymap=narze -e subproject=infinity -e keyboard=ergodox --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware
  33 avr-objcopy -Iihex -Obinary .build/ergodox_infinity_narze.hex .build/ergodox_infinity_narze_left.bin
  34 dfu-util --device 1c11:b007 -D .build/ergodox_infinity_narze_left.bin
  35 ```
  36
  37 #### Right side
  38 ```
  39 docker run -e keymap=narze -e subproject=infinity -e keyboard=ergodox -e MASTER=right --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware
  40 avr-objcopy -Iihex -Obinary .build/ergodox_infinity_narze.hex .build/ergodox_infinity_narze_right.bin
  41 dfu-util --device 1c11:b007 -D .build/ergodox_infinity_narze_right.bin
  42 ```
  43
  44 ## TODO
  45 - [ ] Make SuperDuper mode fully-compatible in Windows by swapping GUI with Ctrl