logo

qmk_firmware

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

readme.md (7303B)

    

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