diff options
author | Florian Beeres <yuuki@protonmail.com> | 2017-11-08 17:13:06 +0100 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2017-11-08 11:13:06 -0500 |
commit | 7e2223f82237ab9c4426e54120cd4ac4d950c79b (patch) | |
tree | 8b5f1202697dcaaa109a74340c319ebe2a4e1a2b /keyboards/xd60/keymaps/yuuki/README.md | |
parent | 3b5381d6893b02b48b9abd4845220cd68d02979f (diff) |
Improved README of yuuki and added RGB commands (#1983)
* Add yuuki keymap
Documentation is still a TODO and the keymap may not be final
* GRV on colon
* add KC_GRV to FN ESC
* more RGB modes
* Update README.md
Add image of layout and fix typo
* switch from jpg to png
For some reason the JPG had red outlines around the keys.
* remove whitespace
* add instruction to reset keyboard before flashing
* gh60 stytle layout
* moved the GH60 style layout to new folder
* add HOME and END
* Add heading
* moved ayanami to other branch
Diffstat (limited to 'keyboards/xd60/keymaps/yuuki/README.md')
-rw-r--r-- | keyboards/xd60/keymaps/yuuki/README.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/keyboards/xd60/keymaps/yuuki/README.md b/keyboards/xd60/keymaps/yuuki/README.md index 83fdbf2b70..ebb2f8c1c9 100644 --- a/keyboards/xd60/keymaps/yuuki/README.md +++ b/keyboards/xd60/keymaps/yuuki/README.md @@ -6,13 +6,18 @@ Customized xd60 keymap with inspirations from HHKB and the layout I used on my V 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 flash .build/xd60_yuuki.hex` * `sudo dfu-programmer atmega32u4 start` ## Layout -See `keymap.c` for the details, but here are the important features: +![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 | | -------------------------- | ---------------------------------- | @@ -23,4 +28,4 @@ See `keymap.c` for the details, but here are the important features: | 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 +| FN + V | & (both for convenience as I use these keys a lot with VIM navigation and I find them hard reach) | |