diff options
Diffstat (limited to 'keyboards/xd60/keymaps/yuuki/README.md')
-rw-r--r-- | keyboards/xd60/keymaps/yuuki/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/xd60/keymaps/yuuki/README.md b/keyboards/xd60/keymaps/yuuki/README.md new file mode 100644 index 000000000..56b2c811c --- /dev/null +++ b/keyboards/xd60/keymaps/yuuki/README.md @@ -0,0 +1,26 @@ +# yuuki's Layout + +Customized xd60 keymap with inspirations from HHKB and the layout I used on my Vortex Core (a 40% keyboard). + +## Programming Instructions + +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: + +* `sudo dfu-programmer atmega32u4 erase` +* `sudo dfu-programmer atmega32u4 flash .build/xd60-yuuki.hex` +* `sudo dfu-programmer atmega32u4 start` + +## Layout + +See `keymap.c` for the details, but here are the important features: + +| Key | Function | +| -------------------------- | ---------------------------------- | +| Capslock | Forward Slash when tapped and Left Control when held | +| Left Control | Temporarily activate function layer | +| FN + ESC | Grave | +| Space Cadet Shift | Left Shift tapped writes ( and Right Shift tapped writes ) | +| FN + HJKL | Arrow Keys | +| Rightmost key in second row from bottom | Temporarily activate function layer | +| FN + C | ^ | +| FN + V | & (both for convenience as I use these keys a lot with VIM navigation and I find them hard reach) |
\ No newline at end of file |