fixed two typos

[qmk_firmware.git] / keyboards / nyquist / keymaps / pitty / README.md

diff --git a/keyboards/nyquist/keymaps/pitty/README.md b/keyboards/nyquist/keymaps/pitty/README.md
index c7dbca68bb298072fd2173db6c8449b74d53f378..af933a6a56b4dc4ce7c6d2051cad8153d085a479 100644 (file)
--- a/keyboards/nyquist/keymaps/pitty/README.md
+++ b/keyboards/nyquist/keymaps/pitty/README.md
@@ -3,3 +3,77 @@
 This Nyquist layout is mostly based of 333fred's keymap (kudos!), modified for my ISO Hungarian taste :)
 
 It's still a WIP.
+
+I wrote the keys that will appear when using Hungarian layout in Windows and the respective English keys in brackets.
+
+
+ ### Qwerty
+```
+,-----------------------------------------------------------------------------------.
+| 0(') |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  | Ö(0) | Ü(-) |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Tab  |   Q  |   W  |   E  |   R  |   T  |  Z(Y)|   U  |   I  |   O  |   P  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Esc  |   A  |   S  |   D  |LTVIMF|   G  |   H  |   J  |   K  |   L  |  É(;)| Á(") |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+|Í/Shft| Y(Z) |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |  -(/)| Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Ctrl |  GUI |  Alt |LOWER |  Spc |  Spc | Bksp | Ent  |  Alt | =(&) | GAME | Del  |
+`-----------------------------------------------------------------------------------'
+```
+ 
+ Tap left shift writes the missing ISO key, hold is Shift. I have 2u Space.
+
+
+ ### Gaming mode (Toggle layer)
+```
+,-----------------------------------------------------------------------------------.
+|      |      |      |      |      |      |      |      |      |      |      |QWERTY|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |      |      |      |      |      |      |Lower |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |   F  |      |      |      |      |      |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Shift|      |      |      |      |      |      |      |      |      |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |      |      |      | Left | Down |  Up  | Right|
+`-----------------------------------------------------------------------------------'
+```
+ 
+Disabled some of the functions in the main layer to help with better gaming experience.
+
+
+ ### Lower (double tap toggles the layer, and hold for momentary switch)
+```
+,-----------------------------------------------------------------------------------.
+|  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|      |      |  Up  |      |  Del |  Ins |      |   7  |   8  |   9  |   /  |      |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|      | Left | Down | Right| Home |  End |      |   4  |   5  |   6  |   *  |      |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|      |      |      | PGUP | PGDN |      |   1  |   2  |   3  |   -  |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |      |      |   0  |   .  |   =  |   +  |      |
+`-----------------------------------------------------------------------------------'
+```
+ 
+ Function layer with everything that is missing from the main layer plus an additional numpad.
+
+
+ ### Vim Movement (Hold down F)
+```
+,-----------------------------------------------------------------------------------.
+|      |      |      |      |DM_stp|      |      |      |      |      |   Ő  |  Ű   |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |DM_REC|      |      |  Ú   |   Í  |   Ó  |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      | DLeft|DRight| LCTRL|      |      | Left | Down |  Up  | Right|      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |      |      |      |      |      |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      | LShft|      |      |      |      |      |      |      |
+`-----------------------------------------------------------------------------------'
+```
+ 
+ Turns hjkl into vim movement. DLeft and DRight macros are for sending WIN+Left and WIN+Right. I moved the respective accented Hungarian letters here.