summaryrefslogtreecommitdiff
path: root/keyboards/pearl/keymaps/cijanzen/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/pearl/keymaps/cijanzen/README.md')
-rw-r--r--keyboards/pearl/keymaps/cijanzen/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/pearl/keymaps/cijanzen/README.md b/keyboards/pearl/keymaps/cijanzen/README.md
new file mode 100644
index 0000000000..745442955f
--- /dev/null
+++ b/keyboards/pearl/keymaps/cijanzen/README.md
@@ -0,0 +1,29 @@
+# cijanzen's Pearl 40%
+
+## Layout
+
+The firmware offers five layers:
+
+1. Base layer
+2. Numbers and arrows (Fn1)
+3. F-row and navigation (Fn2)
+4. Media and RGB controls (Fn3)
+5. Utils (Fn2+Fn3)
+
+A few specifics worth mentioning:
+- Autoshift has been enabled to allow for easier access of shifted keys
+- Tab will operate as tab key on tap and fn layer on hold
+- Indicator LEDs indicate the current layer
+
+
+![cijanzen's Pearl 40% layout](https://raw.githubusercontent.com/christopherjanzen/qmk_firmware/bab090ee24866e6c38892ffc5ffa53813aec3832/keyboards/pearl/keymaps/cijanzen/pearl-cijanzen-keymap.jpg)
+
+Base for this firmware copied from jetpacktuxedo's and rask's QMK firmware
+
+---
+
+## Compiling and flashing
+
+To compile and flash the HEX follow the [Pearl 40% instructions](https://gist.github.com/clee/a43f198a70de0e6dae22d7638b41440a).
+
+You might need to check the comments at the bottom of the gist as well.