summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/neo2planck/readme.md
diff options
context:
space:
mode:
authoryellowmoneybank <16255242+yellowmoneybank@users.noreply.github.com>2017-11-20 18:22:16 +0100
committerJack Humbert <jack.humb@gmail.com>2017-11-20 12:22:16 -0500
commitc6cdd5422fb64e8854db9cbd3ba2ca2f3b7418e8 (patch)
tree07e81461bee1a45545dc85b22726f2e632ee2d81 /keyboards/planck/keymaps/neo2planck/readme.md
parentd6ca4e555ac52a446b1657ac3f3027655fe5ab5b (diff)
downloadqmk_firmware-c6cdd5422fb64e8854db9cbd3ba2ca2f3b7418e8.tar.gz
qmk_firmware-c6cdd5422fb64e8854db9cbd3ba2ca2f3b7418e8.zip
Neo2Planck (#2032)
* Documentation * Enabled Mouse-Keys in Makefile * Layer 1 finished * Small Bugfixes * Updated documentation
Diffstat (limited to 'keyboards/planck/keymaps/neo2planck/readme.md')
-rw-r--r--keyboards/planck/keymaps/neo2planck/readme.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/neo2planck/readme.md b/keyboards/planck/keymaps/neo2planck/readme.md
new file mode 100644
index 0000000000..2f1c320571
--- /dev/null
+++ b/keyboards/planck/keymaps/neo2planck/readme.md
@@ -0,0 +1,64 @@
+Neo2Planck
+=====================================
+
+This layout tries to emulate Neo2, and is intended to be used with a German QWERTZ softwarelayout.
+It has "üäöß" as it is optimized for a mix of German & English.
+The special character layer and the navigation & number block layer are designed to keep the fingers near the home row.
+
+This layout has some adaptations, due to the limited keys available:
+* function-keys moved to the bottom row
+* press M1 + M2 to get to layer 3
+
+Neo2 wiki page: http://wiki.neo-layout.org/
+
+## Neo2 Base Layer
+```
+ ,-----------------------------------------------------------------------------------.
+ | Esc | X | V | L | C | W | K | H | G | F | Q | Bksp |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Ent | U | I | A | E | O | S | N | R | T | D | Y |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| Ü | Ö | Ä | P | Z | B | M | , | . | J |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt |MRight| Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
+
+# M1 Special Characters
+```
+ ,-----------------------------------------------------------------------------------.
+ | Esc | | _ | [ | ] | ^ | ! | < | > | = | & | ß |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | \ | / | { | } | * | ? | ( | ) | - | : | @ |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| # | $ | | | ~ | ` | + | % | " | ' | ; |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
+
+## M2 Navigation & Number Blocks
+```
+ ,-----------------------------------------------------------------------------------.
+ | | PgUp | Bksp | Up | DEL | PgDn | | 7 | 8 | 9 | | Ins |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | Home | Lft | Down | Right| End | | 4 | 5 | 6 | . | Enter|
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| | Tab | | Enter| | 0 | 1 | 2 | 3 | , |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+```
+
+## M3 F-Keys and Media-Keys
+```
+ ,-----------------------------------------------------------------------------------.
+ | | | Print|Scroll|Pause | | | F7 | F8 | F9 | F12 | |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Tab | | Mute | Vol- | Vol+ | | ³ | F4 | F5 | F6 | F11 | Enter|
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| | Prev | Play | Next | | ² | F1 | F2 | F3 | F10 |Shift |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Ctrl | GUI | Alt | M2 | M1 | Space | M1 | M2 | Alt | Esc | Ctrl |
+ `-----------------------------------------------------------------------------------'
+```