keyboards/dz60/keymaps/billiams/readme.md

   1 ## Billiam's DZ60 layout
   2
   3 This layout is optimized for MacOS and is for a Build 4 DZ60 with a 2U left shift, 2U right shift and an arrow
   4 cluster in the bottom right. Don't use this layout if you didn't get Build 4, you will enter a world of pain Donny.
   5
   6 Settings:
   7
   8 * The `CAPS LOCK` key is replaced with a second function key.
   9 * The `ALT` and `CMD` keys are swapped to replicate the Mac layout.
  10 * Del is available as `Fn` + `Backspace`
  11 * `/ ?` are available when you tap the right shift. Otherwise RShift is shift when held down
  12 * RESET is available as `Fn`+ ` ESC`
  13 * Underglow toggle is available as `Fn` + `Q`. Yes your keyboard has lights even if you didn't get the LEDs. Bonus!
  14 * vim-style arrow key bindings H J K L in layer 1
  15
  16 ### Initial Installation
  17
  18 I found the instructions to be longer than they had to be, and I ended up having to Google some steps anyway. These are the steps I took to get my keyboard setup, in case you are new to the process.
  19
  20 1. Clone the qmk_firmware repo locally
  21 ```
  22 # Choose one:
  23 git clone git@github.com:qmk/qmk_firmware.git # OR
  24 git clone https://github.com/qmk/qmk_firmware.git
  25 ```
  26 2. Customize your layout by starting with a [keymap](https://github.com/qmk/qmk_firmware/tree/master/keyboards/dz60/keymaps). I copied [StephenGrier](https://github.com/qmk/qmk_firmware/tree/master/keyboards/dz60/keymaps/stephengrier)'s and modified it for DZ60 Build 4 and changed a few things, like the `grave` key, `ESC` and `/`.
  27
  28 3. Build your hex file
  29 ```
  30 make dz60:billiams # be in the qmk_firmware directory to do this
  31 ```
  32 A hex file `dz60_billiams.hex` will be created in the base qmk_firmware directory
  33
  34 4. Before plugging in your keyboard into your computer, hold `SPACE` and `B` keys down
  35 5. Holding those keys down, plug the keyboard into your computer, which will put the keyboard in bootlegger mode
  36 6. If you are using [QMK toolbox](https://github.com/qmk/qmk_toolbox/releases), upload the .hex file you made above, select it and hit the flash button. For the love of all that is good and holy on Earth, don't hit the load button, that will load the default keymap and that's not what you want! Unless it is, in which case click away.
  37
  38 Note: If you didn't follow my instructions in 4 and accidentally loaded the default keymap, then to `RESET` the keyboard and kick it into bootleg mode again, hold the `down arrow` key and `\`. The default layout is Build 1 and sets the `MENU` key on that build to `Fn`. `MENU` corresponds to `down arrow` in build 4. Note that you don't have to unplug the keyboard.
  39
  40 Hope this helps!
  41
  42 ### 0 Qwerty
  43 ```
  44 ,-----------------------------------------------------------------------------------------.
  45 |  `  |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |  -  |  =  |   Bkspc   |
  46 |-----------------------------------------------------------------------------------------+
  47 | Tab    |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  [  |  ]  |    \   |
  48 |-----------------------------------------------------------------------------------------+
  49 |   Fn    |  A  |  S  |  D  |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |    Enter    |
  50 |-----------------------------------------------------------------------------------------+
  51 | Shift     |  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  | Tap:/ RSh |  U  | ESC |
  52 |-----------------------------------------------------------------------------------------+
  53 | Ctrl |  Alt  |  Cmd  |              Space                | Alt |  Fn  |  L  |  D  |  R  |
  54 `-----------------------------------------------------------------------------------------'
  55 ```
  56
  57 ### 1 Fn Layer
  58 ```
  59 FN Layer
  60 ,-----------------------------------------------------------------------------------------.
  61 |  `  |  F1 |  F2 |  F3 |  F4 |  F5 |  F6 |  F7 |  F8 |  F9 | F10 | F11 | F12 |    DEL    |
  62 |-----------------------------------------------------------------------------------------+
  63 |        |RBB T|RGB M| Hue-| Hue+| Sat-| Sat+| Val-| Val+| Mute | Vol-| Vol+| Prev | Next |
  64 |-----------------------------------------------------------------------------------------+
  65 |         |     |     |     |     |     | Left| Down| Up |Right|      |      | Play/Pause |
  66 |-----------------------------------------------------------------------------------------+
  67 |           |     |     |     |     |     |     |     |Scr- |Scr+ |         | PG_UP |RESET|
  68 |-----------------------------------------------------------------------------------------+
  69 |      |       |       |                                 |     |     | HOME | PG_DN | END |
  70 `-----------------------------------------------------------------------------------------'
  71 ```
  72