]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/xd60/keymaps/yuuki/README.md
Improved README of yuuki and added RGB commands (#1983)
[qmk_firmware.git] / keyboards / xd60 / keymaps / yuuki / README.md
1 # yuuki's Layout
2
3 Customized xd60 keymap with inspirations from HHKB and the layout I used on my Vortex Core (a 40% keyboard).
4
5 ## Programming Instructions
6
7 Change the layout in `keymap.c` then run `make xd60:yuuki`. The compiled file will be located in `.build/xd60_yuuki.hex` relative to the project root. To flash it onto your keyboard, use whatever program works on your OS. I personally use `dfu-programmer`, and run:
8
9 * reset keyboard by pressing the reset button on the back of the PCB
10 * `sudo dfu-programmer atmega32u4 erase`
11 * `sudo dfu-programmer atmega32u4 flash .build/xd60_yuuki.hex`
12 * `sudo dfu-programmer atmega32u4 start`
13
14 ## Layout
15
16 ![Keyboard Layout](https://github.com/cideM/cidem.github.io/blob/master/keyboard-layout.png "Layout")
17
18 Upper row is default layer, bottom row is function layer. I Didn't include the symbols, such as @,# or $, as their placement is just as you'd expect it.
19
20 ## Summary of Changes
21
22 | Key                        | Function                           |
23 | -------------------------- | ---------------------------------- |
24 | Capslock | Forward Slash when tapped and Left Control when held |
25 | Left Control | Temporarily activate function layer |
26 | FN + ESC | Grave |
27 | Space Cadet Shift | Left Shift tapped writes ( and Right Shift tapped writes )  |
28 | FN + HJKL | Arrow Keys |
29 | Rightmost key in second row from bottom | Temporarily activate function layer |
30 | FN + C | ^ |
31 | FN + V | & (both for convenience as I use these keys a lot with VIM navigation and I find them hard reach) |