From b44bffe954dca574bf6ef16b8c8d985e9547d3e1 Mon Sep 17 00:00:00 2001
From: yhaliaw <43424755+yhaliaw@users.noreply.github.com>
Date: Mon, 15 Mar 2021 04:19:05 +0800
Subject: [Keymap] Add yhaliaw keymap for Planck/Rev6.1. (#11318)

---
 keyboards/planck/keymaps/yhaliaw/readme.md | 32 ++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 keyboards/planck/keymaps/yhaliaw/readme.md

(limited to 'keyboards/planck/keymaps/yhaliaw/readme.md')

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
+![yhaliaw planck layout](https://i.imgur.com/HvYva64.png)
\ No newline at end of file
-- 
cgit v1.2.3