]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/contra/keymaps/basic/readme.md
Fixed issues with MxSS RGB functionality (#3341)
[qmk_firmware.git] / keyboards / contra / keymaps / basic / readme.md
1 # A Basic Contra Layout
2
3 The *default* layout currently (as of Mar 19, 2018) has a lot of components from Planck's default layout and is not very suitable for a basic Contra board. This basic layout is developed from Planck's default layout but has removed the parts that's irrelevant to a Contra board.  
4
5 My other keyboard is a HHKB and I don't use `Tab` or `Esc` key that much and hence the unusual placements for those keys.
6
7 ## QWERTY (Normal) Layer
8 ```
9 ,-----------------------------------------------------------------------------------.
10  | `    |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
11  |------+------+------+------+------+-------------+------+------+------+------+------|
12  | Ctrl |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  '   |
13  |------+------+------+------+------+------|------+------+------+------+------+------|
14  | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
15  |------+------+------+------+------+------+------+------+------+------+------+------|
16  | Esc  | Tab  | Alt  | GUI  |Lower |    Space    |Raise | Left |Right |  Up  |Down  |
17  `-----------------------------------------------------------------------------------'
18 ```
19
20 ## Colemak Layer
21 Switch from `Adjust` layer.
22 ```
23 ,-----------------------------------------------------------------------------------.
24  | `    |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
25  |------+------+------+------+------+-------------+------+------+------+------+------|
26  | Ctrl |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  '   |
27  |------+------+------+------+------+------|------+------+------+------+------+------|
28  | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
29  |------+------+------+------+------+------+------+------+------+------+------+------|
30  | Esc  | Tab  | Alt  | GUI  |Lower |    Space    |Raise | Left |Right |  Up  |Down  |
31  `-----------------------------------------------------------------------------------'
32 ```
33
34 ## Lower
35 ```
36 ,-----------------------------------------------------------------------------------.
37  |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Bksp |
38  |------+------+------+------+------+-------------+------+------+------+------+------|
39  | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
40  |------+------+------+------+------+------|------+------+------+------+------+------|
41  |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | | Home | End  |      |
42  |------+------+------+------+------+------+------+------+------+------+------+------|
43  |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
44  `-----------------------------------------------------------------------------------'
45 ```
46
47 ## Raise
48 ```
49 ,-----------------------------------------------------------------------------------.
50  |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Bksp |
51  |------+------+------+------+------+-------------+------+------+------+------+------|
52  | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
53  |------+------+------+------+------+------|------+------+------+------+------+------|
54  |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |Pg Up |Pg Dn |      |
55  |------+------+------+------+------+------+------+------+------+------+------+------|
56  |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
57  `-----------------------------------------------------------------------------------'
58 ```
59
60 ## Adjust
61 `AGnorm` and `AGswap` switches `alt` and `os` key on the keyboard.
62 ```
63 ,-----------------------------------------------------------------------------------.
64  |      |      |      |      |      |      |      |      |      |      |      |  Del |
65  |------+------+------+------+------+-------------+------+------+------+------+------|
66  |      |      |      |      |      |AGnorm|AGswap|Qwerty|Colemk|      |      |      |
67  |------+------+------+------+------+------|------+------+------+------+------+------|
68  |      |      |      |      |      |      |      |      |      |      |      |      |
69  |------+------+------+------+------+------+------+------+------+------+------+------|
70  |      |      |      |      |      |             |      |      |      |      |      |
71  `-----------------------------------------------------------------------------------'
72 ```