summaryrefslogtreecommitdiff
path: root/keyboards/pearl/keymaps/rask/README.md
diff options
context:
space:
mode:
authorOtto Rask <ojrask@gmail.com>2018-03-19 16:25:46 +0200
committerJack Humbert <jack.humb@gmail.com>2018-03-26 13:34:53 -0400
commitb922a550dc166b1e790906e454ed65c58acfb76f (patch)
tree13edc33f50a88a9dfec5f70a920e42483dd0c92c /keyboards/pearl/keymaps/rask/README.md
parentee1bb85542a297bb2086668ff757fcabf40a9a92 (diff)
Add pearl README, add rask's Pearl layout
Diffstat (limited to 'keyboards/pearl/keymaps/rask/README.md')
-rw-r--r--keyboards/pearl/keymaps/rask/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/pearl/keymaps/rask/README.md b/keyboards/pearl/keymaps/rask/README.md
new file mode 100644
index 0000000000..79465ffd9d
--- /dev/null
+++ b/keyboards/pearl/keymaps/rask/README.md
@@ -0,0 +1,23 @@
+# rask's Pearl 40%
+
+## Layout
+
+The firmware offers five layers:
+
+1. Base layer
+2. Base with numbers and symbols (Fn1)
+3. Base with F-row and arrows (Fn2)
+4. Base with media and RGB controls (Fn3)
+5. More nav and utils (Fn2+Fn3, aka NavFn)
+
+![rask's Pearl 40% layout](https://i.imgur.com/gKVQapZ.png)
+
+Base for this firmware copied from jetpacktuxedo's QMK firmware.
+
+---
+
+## Compiling and flashing
+
+To compile a HEX follow the Pearl 40% instructions.
+
+Flashing instructions also available at Pearl 40% instructions.