keyboards/rgbkb/sol/keymaps/default/readme.md

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