logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

readme.md (8900B)

    

  1. # The Default Helix Layout
  2. ## Layout
  4. ### Qwerty
  6. ```
  7.  ,-----------------------------------------.             ,-----------------------------------------.
  8.  |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
  9.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  10.  | Tab  |   Q  |   W  |   E  |   R  |   T  |             |   Y  |   U  |   I  |   O  |   P  | Bksp |
  11.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  12.  | Ctrl |   A  |   S  |   D  |   F  |   G  |             |   H  |   J  |   K  |   L  |   ;  |  '   |
  13.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  14.  | Shift|   Z  |   X  |   C  |   V  |   B  |   [  |   ]  |   N  |   M  |   ,  |   .  |   /  |Enter |
  15.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  16.  |Adjust| Esc  | Alt  | GUI  | EISU |Lower |Space |Space |Raise | KANA | Left | Down |  Up  |Right |
  17.  `-------------------------------------------------------------------------------------------------'
  18. ```
  20. ### Colemak
  21. ```
  22.  ,-----------------------------------------.             ,-----------------------------------------.
  23.  |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
  24.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  25.  | Tab  |   Q  |   W  |   F  |   P  |   G  |             |   J  |   L  |   U  |   Y  |   ;  | Bksp |
  26.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  27.  | Ctrl |   A  |   R  |   S  |   T  |   D  |             |   H  |   N  |   E  |   I  |   O  |  '   |
  28.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  29.  | Shift|   Z  |   X  |   C  |   V  |   B  |   [  |   ]  |   K  |   M  |   ,  |   .  |   /  |Enter |
  30.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  31.  |Adjust| Esc  | Alt  | GUI  | EISU |Lower |Space |Space |Raise | KANA | Left | Down |  Up  |Right |
  32.  `-------------------------------------------------------------------------------------------------'
  33. ```
  35. ### Dvorak
  36. ```
  37.  ,-----------------------------------------.             ,-----------------------------------------.
  38.  |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Bksp |
  39.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  40.  | Tab  |   '  |   ,  |   .  |   P  |   Y  |             |   F  |   G  |   C  |   R  |   L  | Del  |
  41.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  42.  | Ctrl |   A  |   O  |   E  |   U  |   I  |             |   D  |   H  |   T  |   N  |   S  |  /   |
  43.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  44.  | Shift|   ;  |   Q  |   J  |   K  |   X  |   [  |   ]  |   B  |   M  |   W  |   V  |   Z  |Enter |
  45.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  46.  |Adjust| Esc  | Alt  | GUI  | EISU |Lower |Space |Space |Raise | KANA | Left | Down |  Up  |Right |
  47.  `-------------------------------------------------------------------------------------------------'
  48. ```
  50. ## Layers
  52. |Priority|number|name|description|
  53. | ---- | ---- | --- | --- |
  54. |high|16|Adjust|Functions|
  55. ||4|Raise|Numeric charactors|
  56. ||3|Lower|Other charactors|
  57. ||2|Dvorak|Dvorak leyout|
  58. ||1|Colemak|Colemak leyout|
  59. |low|0|Qwerty|QWERTY leyout(base)|
  61. ### Lower
  62. ```
  63.  ,-----------------------------------------.             ,-----------------------------------------.
  64.  |   ~  |   !  |   @  |   #  |   $  |   %  |             |   ^  |   &  |   *  |   (  |   )  |      |
  65.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  66.  |   ~  |   !  |   @  |   #  |   $  |   %  |             |   ^  |   &  |   *  |   (  |   )  |      |
  67.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  68.  |      |  F1  |  F2  |  F3  |  F4  |  F5  |             |  F6  |   _  |   +  |   {  |   }  |  |   |
  69.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  70.  |      |  F7  |  F8  |  F9  |  F10 |  F11 |  (   |   )  |  F12 |      |      | Home | End  |      |
  71.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  72.  |      |      |      |      |      |      |      |      |      |      | Next | Vol- | Vol+ | Play |
  73.  `-------------------------------------------------------------------------------------------------'
  74. ```
  76. ### Raise
  77. ```
  78.  ,-----------------------------------------.             ,-----------------------------------------.
  79.  |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Bksp |
  80.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  81.  |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
  82.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  83.  |      |  F1  |  F2  |  F3  |  F4  |  F5  |             |  F6  |   -  |   =  |   [  |   ]  |  \   |
  84.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  85.  |      |  F7  |  F8  |  F9  |  F10 |  F11 |      |      |  F12 |      |      |PageDn|PageUp|      |
  86.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  87.  |      |      |      |      |      |      |      |      |      |      | Next | Vol- | Vol+ | Play |
  88.  `-------------------------------------------------------------------------------------------------'
  89. ```
  91. ### Adjust (Lower + Raise)
  92. ```
  93.  ,-----------------------------------------.             ,-----------------------------------------.
  94.  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |             |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
  95.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  96.  |      | Reset|RGBRST|      |      |      |             |      |      |      |      |      |  Del |
  97.  |------+------+------+------+------+------|             |------+------+------+------+------+------|
  98.  |      |      |      |Aud on|Audoff| Mac  |             | Win  |Qwerty|Colemk|Dvorak|      |      |
  99.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  100.  |      |      |      |      |      |      |      |      |      |      |RGB ON| HUE+ | SAT+ | VAL+ |
  101.  |------+------+------+------+------+------+------+------+------+------+------+------+------+------|
  102.  |      |      |      |      |      |      |      |      |      |      | MODE | HUE- | SAT- | VAL- |
  103.  `-------------------------------------------------------------------------------------------------'
  104. ```
  106. ## Customize
  108. see `qmk_firmware/keyboards/helix/rev2/keymaps/default/rules.mk`
  110. ```
  111. # Helix Spacific Build Options
  112. # you can uncomment and edit follows 7 Variables
  113. #  jp: 以下の7つの変数を必要に応じて編集し、コメントアウトをはずします。
  114. # OLED_ENABLE = yes           # OLED_ENABLE
  115. # LOCAL_GLCDFONT = no         # use each keymaps "helixfont.h" insted of "common/glcdfont.c"
  116. # LED_BACK_ENABLE = no        # LED backlight (Enable WS2812 RGB underlight.)
  117. # LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight.)
  118. # LED_ANIMATIONS = yes        # LED animations
  119. # IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
  120. ```
  121. ## Compile
  123. go to qmk top directory.
  124. ```
  125. $ cd qmk_firmware
  126. ```
  128. build
  129. ```
  130. $ make helix:default                         # with oled
  131. $ make helix/rev2/back:default               # with oled and backlight
  132. $ make HELIX=no-ani helix/rev2/back:default  # with oled and backlight without animation
  133. $ make helix/rev2/under:default              # with oled and underglow
  134. $ make HELIX=no-oled helix:default           # without oled
  135. ```
  137. build (experimental use of split_common with backlight and oled)
  138. ```
  139. $ make helix/rev2/sc:default
  140. ```
  142. flash to keyboard
  143. ```
  144. $ make helix:default:flash                         # with oled
  145. $ make helix/rev2/back:default:flash               # with oled and backlight
  146. $ make HELIX=no-ani helix/rev2/back:default:flash  # with oled and backlight without animation
  147. $ make helix/rev2/under:default:flash              # with oled and underglow
  148. $ make HELIX=no-oled helix:default:flash           # without oled
  149. ```
  151. ## Link
  152. * more detail wrote in Japanese [helix/Doc/firmware_jp.md](https://github.com/MakotoKurauchi/helix/blob/master/Doc/firmware_jp.md)
  153. * [Helix top](https://github.com/MakotoKurauchi/helix)