summaryrefslogtreecommitdiffstats
path: root/keyboards/xiudi/xd60/keymaps/yuuki/README.md
diff options
context:
space:
mode:
authorpeepeetee <43021794+peepeetee@users.noreply.github.com>2021-08-21 22:53:49 -0500
committerGitHub <noreply@github.com>2021-08-22 13:53:49 +1000
commit78ccd9c201199444bc06161b05ee8d7ba9c31613 (patch)
tree726d9e55d8cde510fe72bc1fb9bb2a7dabdbecc2 /keyboards/xiudi/xd60/keymaps/yuuki/README.md
parentc70abc8d047319830e369ae4e14cd43bae3bd3b8 (diff)
Organize KPrepublic, K.T.E.C, xiudi boards into directories (#12159)
* reset; redoing my steps; and recommit * include xd002/.noci
Diffstat (limited to 'keyboards/xiudi/xd60/keymaps/yuuki/README.md')
-rw-r--r--keyboards/xiudi/xd60/keymaps/yuuki/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/xiudi/xd60/keymaps/yuuki/README.md b/keyboards/xiudi/xd60/keymaps/yuuki/README.md
new file mode 100644
index 0000000000..ebb2f8c1c9
--- /dev/null
+++ b/keyboards/xiudi/xd60/keymaps/yuuki/README.md
@@ -0,0 +1,31 @@
+# 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:
+
+* reset keyboard by pressing the reset button on the back of the PCB
+* `sudo dfu-programmer atmega32u4 erase`
+* `sudo dfu-programmer atmega32u4 flash .build/xd60_yuuki.hex`
+* `sudo dfu-programmer atmega32u4 start`
+
+## Layout
+
+![Keyboard Layout](https://github.com/cideM/cidem.github.io/blob/master/keyboard-layout.png "Layout")
+
+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.
+
+## Summary of Changes
+
+| 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) |