keyboards/zygomorph/keymaps/kageurufu/readme.md

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