logo

qmk_firmware

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

readme_en.md (6769B)


  1. # The Default Zinc Layout
  2. ## layout
  3. ### Qwerty
  4. ```
  5. ,-----------------------------------------. ,-----------------------------------------.
  6. | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
  7. |------+------+------+------+------+------| |------+------+------+------+------+------|
  8. | Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
  9. |------+------+------+------+------+------| |------+------+------+------+------+------|
  10. | Shift| Z | X | C | V | B | | N | M | , | . | / |Enter |
  11. |------+------+------+------+------+------| |------+------+------+------+------+------|
  12. | Esc | Fn | Alt | Win |Lower |Space | | Space| Raise| Left | Down | Up | Right|
  13. `------------------------------------------ ------------------------------------------'
  14. ```
  15. ### Colemak
  16. ```
  17. ,-----------------------------------------. ,-----------------------------------------.
  18. | Tab | Q | W | F | P | G | | J | L | U | Y | ; | Bksp |
  19. |------+------+------+------+------+------| |------+------+------+------+------+------|
  20. | Ctrl | A | R | S | T | D | | H | N | E | I | O | ' |
  21. |------+------+------+------+------+------| |------+------+------+------+------+------|
  22. | Shift| Z | X | C | V | B | | K | M | , | . | / |Enter |
  23. |------+------+------+------+------+------| |------+------+------+------+------+------|
  24. | Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
  25. `------------------------------------------ ------------------------------------------'
  26. ```
  27. ### Dvorak
  28. ```
  29. ,-----------------------------------------. ,-----------------------------------------.
  30. | Tab | ' | , | . | P | Y | | F | G | C | R | L | Del |
  31. |------+------+------+------+------+------| |------+------+------+------+------+------|
  32. | Ctrl | A | O | E | U | I | | D | H | T | N | S | / |
  33. |------+------+------+------+------+------| |------+------+------+------+------+------|
  34. | Shift| ; | Q | J | K | X | | B | M | W | V | Z |Enter |
  35. |------+------+------+------+------+------| |------+------+------+------+------+------|
  36. | Esc |ADJUST| Alt | Win |LOWER |Space | | Space| RAISE| Left | Down | Up | Right|
  37. `-----------------------------------------' `-----------------------------------------'
  38. ```
  39. ### Lower
  40. ```
  41. ,-----------------------------------------. ,-----------------------------------------.
  42. | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
  43. |------+------+------+------+------+------| |------+------+------+------+------+------|
  44. | | | | | | | | - | _ | + | { | } | | |
  45. |------+------+------+------+------+------| |------+------+------+------+------+------|
  46. | | | | | | | | | | | Home | End | |
  47. |------+------+------+------+------+------| |------+------+------+------+------+------|
  48. | | | | | | | | | | Next | Vol- | Vol+ | Play |
  49. `-----------------------------------------' `-----------------------------------------'
  50. ```
  51. ### RAISE
  52. ```
  53. ,-----------------------------------------. ,-----------------------------------------.
  54. | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
  55. |------+------+------+------+------+------| |------+------+------+------+------+------|
  56. | | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
  57. |------+------+------+------+------+------| |------+------+------+------+------+------|
  58. | | F7 | F8 | F9 | F10 | F11 | | F12 | | | | |
  59. |------+------+------+------+------+------| |------+------+------+------+------+------|
  60. | | | | | | | | | | Next | Vol- | Vol+ | Play |
  61. `-----------------------------------------' `-----------------------------------------'
  62. ```
  63. ### Adjust (Lower + Raise)
  64. ```
  65. ,-----------------------------------------. ,-----------------------------------------.
  66. | | Reset|RGBRST|Aud on|Audoff| | | |Qwerty|Colemk|Dvorak| | Ins |
  67. |------+------+------+------+------+------| |------+------+------+------+------+------|
  68. | |RGB ON| HUE+ | SAT+ | VAL+ | Mac | | Win | - | = |Print |ScLock|Pause |
  69. |------+------+------+------+------+------| |------+------+------+------+------+------|
  70. |MODE R|RGBMOD| HUE- | SAT- | VAL- | | | | | | |PageUp| |
  71. |------+------+------+------+------+------| |------+------+------+------+------+------|
  72. | | | | EISU | EISU | EISU | | KANA | KANA | KANA | Home |PageDn| End |
  73. `-----------------------------------------' `-----------------------------------------'
  74. ```
  75. ## Compile
  76. go to qmk top directory.
  77. ```
  78. $ cd qmk_firmware
  79. ```
  80. make with `zinc:<keymap_name>`
  81. ```
  82. $ make zinc:default
  83. ```
  84. To make and flash with `:flash`
  85. ```
  86. $ make zinc:default:flash
  87. ```
  88. ## Customize
  89. You can customize from the command line.
  90. ```
  91. # Zinc keyboard 'default' keymap: convenient command line option
  92. make ZINC=<options> zinc:defualt
  93. # option= back | under | both | cont | na | ios
  94. # ex.
  95. # make ZINC=under zinc:defualt
  96. # make ZINC=under,ios zinc:defualt
  97. # make ZINC=back zinc:default
  98. # make ZINC=back,na zinc:default
  99. # make ZINC=back,ios zinc:default
  100. ```
  101. Or edit `qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` directly.
  102. ```
  103. # Zinc keyboard customize
  104. LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
  105. LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
  106. LED_BOTH_ENABLE = no # LED backlight and underglow
  107. LED_RGB_CONT = no # LED continuous backlight or/and underglow between left Zinc and right Zinc
  108. LED_ANIMATIONS = yes # LED animations
  109. IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
  110. ```