summaryrefslogtreecommitdiff
path: root/keyboards/crkbd/keymaps/jpe230/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/crkbd/keymaps/jpe230/readme.md')
-rw-r--r--keyboards/crkbd/keymaps/jpe230/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/crkbd/keymaps/jpe230/readme.md b/keyboards/crkbd/keymaps/jpe230/readme.md
new file mode 100644
index 0000000000..31bbc4ebd1
--- /dev/null
+++ b/keyboards/crkbd/keymaps/jpe230/readme.md
@@ -0,0 +1,15 @@
+# Jpe230's CRKBD Layout
+
+## Layers
+The four layers:
+- BASE Layer: QWERTY
+- LOWER Layer: Numbers + Arrows
+- RAISE Layer: Symbols
+- ADJUST Layer: Numpad + Media Keys + Fn keys
+
+## OLED
+-Master: Renders layer state + keylog
+-Slave : Renders an animation of a cat that varies its animation speed based on the current WPM
+
+## Flashing
+Flash using `qmk compile -kb crkbd -km jpe230` for Pro Micro