summaryrefslogtreecommitdiffstats
path: root/keyboards
diff options
context:
space:
mode:
authorDennis Trümper <truemper.accipiter@gmail.com>2017-03-11 11:44:39 +0100
committerDennis Trümper <truemper.accipiter@gmail.com>2017-03-11 11:44:39 +0100
commitedb8fcc8102ae86807b70750e57db0de9d49047c (patch)
treed379e84c9c081b8a31be83ca5f3aa7050eb62892 /keyboards
parent303f5aed41aac700b6cbc5a2ce06a872d5b85d88 (diff)
update documentation
Diffstat (limited to 'keyboards')
-rw-r--r--keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.c75
-rw-r--r--keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.md90
2 files changed, 86 insertions, 79 deletions
diff --git a/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.c b/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.c
index 0401966005..ab2464c424 100644
--- a/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.c
+++ b/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.c
@@ -5,7 +5,7 @@
#define UM 0
#define L0 0 // layer_0
-#define L1 1 // layer_1
+#define L1 1 // layer_1
#define L2 2 // layer_2
#define L3 3 // layer_3
#define L4 4 // layer_4
@@ -14,24 +14,25 @@
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/*
- * .------------------------------------.------------------------------------.
- * |ESC | 1 | 2 | 3 | 4 | 5 |ACUT | GRV | 6 | 7 | 8 | 9 | 0 |CIRC |
- * !-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
- * |TAB | X | V | L | C | W |Print| | K | H | G | F | Q | SS |
- * !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- * |MO(1)| U | I | A | E | O |-----!-----! S | N | R | T | D | Y |
- * !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- * |LSFT | UE | OE | AE | P | Z |SPACE| | B | M |COMM| DOT| J |RSFT |
- * '-----+----+----+----+----+----------'----------+----+----+----+----+-----'
- * |LCTL|LGUI|LALT|MO(3)|MO(2)| !MO(2)|MO(3)|APP |RALT|RCTL|
- * '------------------------' '------------------------'
- * .-----------. .-----------.
- * |VOL- |VOL+ | !MUTE |PLAY |
- * .-----+-----+-----! !-----+-----+-----.
- * ! ! | | ! | ! !
- * ! CTL ! !-ALT-! !-CTL-! ! ALT !
- * |ENTER|MO(1)| TAB | !ESC |MO(1)|SPACE|
- * '-----------------' '-----------------'
+ .------------------------------------.------------------------------------.
+ |ESC | 1 | 2 | 3 | 4 | 5 | ´ | ` | 6 | 7 | 8 | 9 | 0 | ^ |
+ !-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
+ |TAB | X | V | L | C | W |Print| | K | H | G | F | Q | ß |
+ !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
+ |MO(1)| U | I | A | E | O |-----!-----! S | N | R | T | D | Y |
+ !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
+ |LSFT | ü | ö | ä | P | Z |SPACE| | B | M | , | . | J |RSFT |
+ '-----+----+----+----+----+----------'----------+----+----+----+----+-----'
+ |LCTL|LGUI|LALT|MO(3)|MO(2)| !MO(2)|MO(3)|APP |RALT|RCTL|
+ '------------------------' '------------------------'
+ .-----------. .-----------.
+ |VOL- |VOL+ | !MUTE |PLAY |
+ .-----+-----+-----! !-----+-----+-----.
+ ! ! | | ! | ! !
+ ! ! |-----| !-----| ! !
+ ! CTL ! ! ALT ! ! CTL ! ! ALT !
+ |ENTER|MO(1)| TAB | !ESC |MO(1)|SPACE|
+ '-----------------' '-----------------'
*/
[L0] = KEYMAP(
KC_ESC, DE_1, DE_2, DE_3, DE_4, DE_5, DE_ACUT,
@@ -52,24 +53,24 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
CTL_T(KC_ESC), MO(1), ALT_T(KC_SPACE)
),
/*
- * .------------------------------------.------------------------------------.
- * | | | | | | | | | | | | | | |
- * !-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
- * | |EURO|UNDS|LBRC|RBRC| | | |EXLM|LESS|MORE|EQL |AMPR| |
- * !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- * | |BSLS|SLSH|LCBR|RCBR|ASTR|-----!-----!QST |LPRN|RPRN|MINS|COLN| AT |
- * !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- * | |HASH|DLR |PIPE|TILD| | | |PLUS|PERC|DQOT|QUOT|SCLN| |
- * '-----+----+----+----+----+----------'----------+----+----+----+----+-----'
- * | | | | | | ! | | | | |
- * '------------------------' '------------------------'
- * .-----------. .-----------.
- * | | | ! | |
- * .-----+-----+-----! !-----+-----+-----.
- * ! ! | | ! | ! !
- * ! ! !-----! !-----! ! !
- * | | | | ! | | |
- * '-----------------' '-----------------'
+ .------------------------------------.------------------------------------.
+ | | | | | | | | | | | | | | |
+ !-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
+ | | € | _ | [ | ] | | | | ! | < | > | = | & | |
+ !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
+ | | \ | / | { | } | * |-----!-----! ? | ( | ) | - | : | @ |
+ !-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
+ | | # | $ | | | ~ | | | | + | % | " | ' | ; | |
+ '-----+----+----+----+----+----------'----------+----+----+----+----+-----'
+ | | | | | | ! | | | | |
+ '------------------------' '------------------------'
+ .-----------. .-----------.
+ | | | ! | |
+ .-----+-----+-----! !-----+-----+-----.
+ ! ! | | ! | ! !
+ ! ! !-----! !-----! ! !
+ | | | | ! | | |
+ '-----------------' '-----------------'
*/
[L1] = KEYMAP(
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
diff --git a/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.md b/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.md
index fdcc86a497..d9fcda9661 100644
--- a/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.md
+++ b/keyboards/ergodox/keymaps/neo2_on_qwerz_hardware/keymap.md
@@ -1,54 +1,57 @@
-# ManuNeo Ergodox Keyboard Layout
-
-Compile this file to a `keymap.c` file using `compile_keymap.py`
-
- python compile_keymap.py keymaps/german-manuneo/keymap.md
+# Neo2 for ErgoDox on QWERTZ
+#
+# Description
+This layout is ment to be used on PCs with DE-de with an additional guest keyboard. E.g. on your PC at work you can use your ergodox with neo but a second keybord is plugged in so your coworkers can enter a few signs if necessary. I live in Germany, so this is my usecase.
+# Layers
+[Layer0](#layer-0)
+Letters, modifiers and volume
-Tested with python 2.7 and python 3.4
+[Layer1](#layer-1)
+Symbols
+[Layer2](#layer-2)
+Motion, digits and next/prev Song
-# Layout Config
+[Layer3](#layer-3)
+F1 to F12 and mouse actions
- {
- "layout": "ergodox_ez",
- "keymaps_includes": [
- "ergodox.h",
- "action_layer.h",
- "keymap_common.h",
- "keymap_extras/keymap_german.h",
- ],
- "key_prefixes": ["DE_", "KC_"],
- "macros": {
- // TODO: implement macros
- // "MUC": "",
- },
- // TODO: implement default unicode mode
- }
+[Layer4](#layer-4)
+not used
+[Layer5](#layer-5)
+not used
-# Layers
+[Layer6](#layer-6)
+not used
## Layer 0
.------------------------------------.------------------------------------.
- |ESC | 1 | 2 | 3 | 4 | 5 |ACUT | GRV | 6 | 7 | 8 | 9 | 0 |CIRC |
+ |ESC | 1 | 2 | 3 | 4 | 5 | ´ | ` | 6 | 7 | 8 | 9 | 0 | ^ |
!-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
- |TAB | X | V | L | C | W | | | K | H | G | F | Q | SS |
+ |TAB | X | V | L | C | W |Print| | K | H | G | F | Q | ß |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
|MO(1)| U | I | A | E | O |-----!-----! S | N | R | T | D | Y |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- |LSFT | UE | OE | AE | P | Z |SPACE| | B | M |COMM| DOT| J |RSFT |
+ |LSFT | ü | ö | ä | P | Z |SPACE| | B | M | , | . | J |RSFT |
'-----+----+----+----+----+----------'----------+----+----+----+----+-----'
- |LCTL|LGUI|LCTL|MO(3)|MO(2)| !MO(2)|MO(3)|APP |RALT|RCTL|
+ |LCTL|LGUI|LALT|MO(3)|MO(2)| !MO(2)|MO(3)|APP |RALT|RCTL|
'------------------------' '------------------------'
.-----------. .-----------.
- | | | ! | |
+ |VOL- |VOL+ | !MUTE |PLAY |
.-----+-----+-----! !-----+-----+-----.
! ! | | ! | ! !
- ! ! !-----! !-----! ! !
- |ENTER|MO(3)|LGUI | !RCTL |MO(1)|SPACE|
+ ! ! |-----| !-----| ! !
+ ! CTL ! ! ALT ! ! CTL ! ! ALT !
+ |ENTER|MO(1)| TAB | !ESC |MO(1)|SPACE|
'-----------------' '-----------------'
+
+* Left side ESC, TAB, [SymbolLayer], Shift, Ctr, Gui(Windows key), and Alt like normal QWERTZ with neo2.
+* Space on right side of left half for mous activity so you don't have to leave the mouse for Space.
+* Top row of thumb keys is hard to reach for me, so I put media control on there.
+* Thumb keys make use of modifier/tap. E.g. if you tap the Enter key it will be Enter. If you keep it pressed down it will be Ctr. The hold action is written on top of the tap action.
+* The small middle thumb keys are not used, es well as the 1.5 sized ones on the left side of the right half.
## Layer 1
@@ -56,11 +59,11 @@ Tested with python 2.7 and python 3.4
.------------------------------------.------------------------------------.
| | | | | | | | | | | | | | |
!-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
- | |EURO|UNDS|LBRC|RBRC| | | |EXLM|LESS|MORE|EQL |AMPR| |
+ | | € | _ | [ | ] | | | | ! | < | > | = | & | |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- | |BSLS|SLSH|LCBR|RCBR|ASTR|-----!-----!QST |LPRN|RPRN|MINS|COLN| AT |
+ | | \ | / | { | } | * |-----!-----! ? | ( | ) | - | : | @ |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- | |HASH|DLR |PIPE|TILD| | | |PLUS|PERC|DQOT|QUOT|SCLN| |
+ | | # | $ | | | ~ | | | | + | % | " | ' | ; | |
'-----+----+----+----+----+----------'----------+----+----+----+----+-----'
| | | | | | ! | | | | |
'------------------------' '------------------------'
@@ -76,15 +79,15 @@ Tested with python 2.7 and python 3.4
## Layer 2
.------------------------------------.------------------------------------.
- | | | | | | | | | | | | | |PEQL |
+ | | | | | | | | | | | | | | |
!-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
- | |PGUP|BSPC| UP |DEL |PGDN| | | | 7 | 8 | 9 |PAST|PSLS |
+ | |PGUP|BSPC| UP |DEL |PGDN| | | | 7 | 8 | 9 | | |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- | |HOME|LEFT|DOWN|RGHT|END |-----!-----! | 4 | 5 | 6 |PMNS| |
+ | |HOME|LEFT|DOWN|RGHT|END |-----!-----! | 4 | 5 | 6 | | |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- | | | | | | | | | | 1 | 2 | 3 |PPLS| |
+ | | | |PREV|NEXT| | | | | 1 | 2 | 3 | | |
'-----+----+----+----+----+----------'----------+----+----+----+----+-----'
- | | | | | | ! | |PCMM|PDOT|PENT|
+ | | | | | | ! | | | | |
'------------------------' '------------------------'
.-----------. .-----------.
| | | ! | |
@@ -101,11 +104,11 @@ Tested with python 2.7 and python 3.4
.------------------------------------.------------------------------------.
| | F1 | F2 | F3 | F4 | F5 | F6 | | | | | | | |
!-----+----+----+----+----+----------!-----+----+----+----+----+----+-----!
- | | F7 | F8 | F9 | F10| F11| F12 | | | | | | | |
+ | | F7 | F8 | F9 | F10| F11| F12 | | |M_WU|M_CU|M_WD| | |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- | | | | | | |-----!-----! | | | | | |
+ |M_B5 |M_B4|M_B3|M_B2|M_B1| |-----!-----! |M_CL|M_CD|M_CR| | |
!-----+----+----+----x----x----! ! !----x----x----+----+----+-----!
- | | | | | | | | | | | | | | |
+ | | |M_A2|M_A1|M_A0| | | | | | | | | |
'-----+----+----+----+----+----------'----------+----+----+----+----+-----'
| | | | | | ! | | | | |
'------------------------' '------------------------'
@@ -116,7 +119,10 @@ Tested with python 2.7 and python 3.4
! ! !-----! !-----! ! !
| | | | ! | | |
'-----------------' '-----------------'
-
+* M_A Mouse acceleration
+* M_B Mouse button
+* M_C Mouse cursor
+* M_W Mouse wheel
## Layer 4