logo

qmk_firmware

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

readme.md (6746B)


  1. # The Default Zygomorph Layout
  2. ## Layout
  3. ### Base modifier layout
  4. ```
  5. * ,-----------------------------------------. ,-----------------------------------------.
  6. * | GESC | | | | | | | | | | | | BkSp |
  7. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  8. * | Tab | | | | | | | | | | | | \ |
  9. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  10. * |FN(CAPS)| | | | | | | | | | | | ' |
  11. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  12. * |Shift | | | | | | | | | | | |Shift |
  13. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  14. * | Ctrl | Win | Alt | RGB | ADJ | Space| | Space| FN | Left | Down | Up |Right |
  15. * `-----------------------------------------' `-----------------------------------------'
  16. ```
  17. ### Qwerty alphas
  18. ```
  19. * ,-----------------------------------------. ,-----------------------------------------.
  20. * | | | | | | | | | | | | | |
  21. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  22. * | | Q | W | E | R | T | | Y | U | I | O | P | |
  23. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  24. * | | A | S | D | F | G | | H | J | K | L | ; | |
  25. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  26. * | | Z | X | C | V | B | | N | M | , | . | / | |
  27. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  28. * | | | | | | | | | | | | | |
  29. * `-----------------------------------------' `-----------------------------------------'
  30. ```
  31. ### Colemak alphas
  32. ```
  33. * ,-----------------------------------------. ,-----------------------------------------.
  34. * | | | | | | | | | | | | | |
  35. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  36. * | | Q | W | F | P | G | | J | L | U | Y | ; | |
  37. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  38. * | | A | R | S | T | D | | H | N | E | I | O | |
  39. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  40. * | | Z | X | C | V | B | | K | M | , | . | / | |
  41. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  42. * | | | | | | | | | | | | | |
  43. * `-----------------------------------------' `-----------------------------------------'
  44. ```
  45. ### Function (FN)
  46. ```
  47. * ,-----------------------------------------. ,-----------------------------------------.
  48. * | F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 |
  49. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  50. * | | PGDN | UP | PGUP | | | | | PGDN | UP | PGUP | PRINT| HOME |
  51. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  52. * | | LEFT | DOWN | RIGHT| | | | | LEFT | DOWN | RIGHT|INSERT| END |
  53. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  54. * | | | | | | | | | | | | | |
  55. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  56. * | | | |RGBMOD| | | | | PLAY | NEXT | MUTE | VOL- | VOL+ |
  57. * `-----------------------------------------' `-----------------------------------------'
  58. ```
  59. ### Adjust (ADJ)
  60. ```
  61. * ,-----------------------------------------. ,-----------------------------------------.
  62. * | F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 |
  63. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  64. * | | SAD | VAI | SAI | QK_BOOT| | | | | | | | |
  65. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  66. * | | HUD | VAD | HUI |RGBRST| | | |QWERTY|COLEMK| | | |
  67. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  68. * | | | | | | | | | |RGBTOG| HUI | SAI | VAI |
  69. * |------+------+------+------+------+------| |------+------+------+------+------+------|
  70. * | | | |RGBMOD| | | | | |RGBRMOD| HUD | SAD | VAD |
  71. * `-----------------------------------------' `-----------------------------------------'
  72. ```
  73. ## Customize
  74. see `qmk_firmware/keyboards/zygomorph/rev1/keymaps/default/rules.mk`
  75. ```
  76. # Variables you can set for Zygomorph
  77. BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite
  78. MOUSEKEY_ENABLE = no # Mouse keys(+4700)
  79. EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
  80. CONSOLE_ENABLE = yes # Console for debug(+400)
  81. COMMAND_ENABLE = no # Commands for debug and configuration
  82. NKRO_ENABLE = no
  83. RGBLIGHT_ENABLE = yes # Enable global lighting effects. Do not enable with RGB Matrix
  84. RGB_MATRIX_ENABLE = no # Enable per-key coordinate based RGB effects. Do not enable with RGBlight (+8500)
  85. RGB_MATRIX_KEYPRESSES = no # Enable reactive per-key effects. Can be very laggy (+1500)
  86. RGBLIGHT_FULL_POWER = yes # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
  87. SWAP_HANDS_ENABLE = no # Enable one-hand typing
  88. ENCODER_ENABLE = yes # Enable rotary encoder (+90)
  89. OLED_ENABLE = yes
  90. IOS_DEVICE_ENABLE = no # Limit max brightness to connect to IOS device (iPad,iPhone)
  91. ```
  92. ## Compile
  93. go to qmk top directory.
  94. ```
  95. $ cd qmk_firmware
  96. ```
  97. build
  98. ```
  99. $ make rgbkb/zygomorph:default
  100. ```
  101. After the initial flash with AVRdudess, you should be able to flash using this:
  102. ```
  103. $ make rgbkb/zygomorph:default:dfu
  104. ```