summaryrefslogtreecommitdiff
path: root/keyboards/xd60/keymaps/birkir/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/xd60/keymaps/birkir/readme.md')
-rw-r--r--keyboards/xd60/keymaps/birkir/readme.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/keyboards/xd60/keymaps/birkir/readme.md b/keyboards/xd60/keymaps/birkir/readme.md
new file mode 100644
index 000000000..670b6bb31
--- /dev/null
+++ b/keyboards/xd60/keymaps/birkir/readme.md
@@ -0,0 +1,45 @@
+# Birkir's Keymap for XIUDI's 60% XD60 PCB
+
+Custom layout with some custom layers. Mac friendly.
+
+## Layout
+![Birkir's Layout](https://i.imgur.com/I69AYG1.png)
+
+### Layer 0
+Base layer as shown on layout above
+
+### Layer 1
+Active while pressing and holding `MENU`
+
+RGB is purple while active
+
+- `ESC` is `~`
+
+### Layer 2
+Toggled on and off with `FN`
+
+RGB is red while active
+
+RGB settings are persisted for layer 0 when done.
+
+ - `1` Backlight DEC
+ - `2` Backlight INC
+ - `3` Backlight OFF
+ - `4` Backlight ON
+ - `5` RGB Toggle
+ - `6` RGB Mode
+ - `7` RGB Hue DEC (-)
+ - `8` RGB Hue INC (+)
+ - `9` RGB Saturation DEC (-)
+ - `0` RGB Saturation INC (+)
+ - `-/_` RGB Brightness DEC (-)
+ - `+/=` RGB Brightness INC (+)
+ - `BACKSPACE` RGB Mode set to PLAIN
+
+## TODO
+
+- Mac shortcuts on Layer 1
+- More dynamic keyboard configuration on Layer 2
+
+## Build
+To build the default keymap, simply run `make xd60:birkir`.