summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/phreed/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/planck/keymaps/phreed/readme.md')
-rw-r--r--keyboards/planck/keymaps/phreed/readme.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/phreed/readme.md b/keyboards/planck/keymaps/phreed/readme.md
new file mode 100644
index 0000000000..9080222e28
--- /dev/null
+++ b/keyboards/planck/keymaps/phreed/readme.md
@@ -0,0 +1,38 @@
+# The Phreed Planck Layout
+
+
+| Q | W | E | R | T | ESC | | \ | Y | U | I | O | P |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+| | | | | | meh | MOD | gui | | | | | |
+| f1 | f2 | f3 | f4 | f5 | f6 |<fn] [num>| < | > | 7 | 8 | 9 | . |
+|home | end | | | | |<cmd][spec>| | | & | * | ~ | |
+
+| A | S | D | F | G | Tab | | ' " | H | J | K | L | ; : |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+| | | | num | | alt | MOD | alt | | fn | | | |
+| f7 | f8 | f9 | f10 | f11 | f12 |<fn] [num>| + | - | 4 | 5 | 6 | 0 |
+|pg up| del | | | | |<cmd][spec>| | | $ | % | ^ | ` |
+
+| Z | X | C | V | B | [ { | | ] } | N | M | , < | . > | / ? |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+| | | |spec | | | MOD | | | cmd | | | |
+| f13 | f14 | f15 | f16 | f17 | f18 |<fn] [num>| * | / | 1 | 2 | 3 | = |
+|pg dn| ins | | | | |<cmd][spec>| | | ! | @ | # | |
+
+| <-- | dwn | <__ |enter| ( | - _ | | = + | ) | spc | __< | up | --> |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+| | | | |shift| ctl | MOD | ctl |shift| | | | |
+| f19 | f20 | f21 | f22 | f23 | f24 |<fn] [num>| | | | | | |
+|pg dn| ins | | | | |<cmd][spec>| | | | | | |
+
+
+Make example for this keyboard (after setting up your build environment):
+
+ make planck-rev3-phreed
+
+To flash the keyboard
+
+ make planck-rev3-phreed-dfu
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the
+[make instructions](https://docs.qmk.fm/make_instructions.html) for more information.