diff options
Diffstat (limited to 'keyboards/planck/keymaps/yhaliaw/readme.md')
| -rw-r--r-- | keyboards/planck/keymaps/yhaliaw/readme.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/yhaliaw/readme.md b/keyboards/planck/keymaps/yhaliaw/readme.md new file mode 100644 index 0000000000..a10e54bd93 --- /dev/null +++ b/keyboards/planck/keymaps/yhaliaw/readme.md @@ -0,0 +1,32 @@ +# yhaliaw Planck layout + +The layout for Planck by yhaliaw. + +Developed and tested on Planck Rev 6.1. + +## Features + +Leader sequences can be used to turn on layers without holding the key and reset the layers. +Leader sequences are triggered by key the series of key in quick succession. +See Base layer notes in Layout section. + +Successful leader sequences will play the planck sound if sound is enabled. + +The RGB underglow is linked to the layers and capslock. + +## Keycodes + +Most Keycodes are standard [QMK keycodes](https://docs.qmk.fm/#/keycodes). + +### Custom Keycodes + +The `RESET` key to start the bootloader is access by a leader sequence. +This is done to prevent a mispress. +See Adjust layer notes in Layout section. + +The `Clear` key is used to clear the EEPROM of the keyboard. +This can be seen as resetting the state of the keyboard. +Replug the keyboard to load in the resetted states. + +## Layout +
\ No newline at end of file |