aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/contra/keymaps/basic/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/contra/keymaps/basic/readme.md')
-rw-r--r--keyboards/contra/keymaps/basic/readme.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/keyboards/contra/keymaps/basic/readme.md b/keyboards/contra/keymaps/basic/readme.md
new file mode 100644
index 000000000..195bc2c1b
--- /dev/null
+++ b/keyboards/contra/keymaps/basic/readme.md
@@ -0,0 +1,72 @@
+# A Basic Contra Layout
+
+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.
+
+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.
+
+## QWERTY (Normal) Layer
+```
+,-----------------------------------------------------------------------------------.
+ | ` | Q | W | E | R | T | Y | U | I | O | P | Bksp |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Ctrl | A | S | D | F | G | H | J | K | L | ; | ' |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Esc | Tab | Alt | GUI |Lower | Space |Raise | Left |Right | Up |Down |
+ `-----------------------------------------------------------------------------------'
+```
+
+## Colemak Layer
+Switch from `Adjust` layer.
+```
+,-----------------------------------------------------------------------------------.
+ | ` | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Ctrl | A | R | S | T | D | H | N | E | I | O | ' |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | Esc | Tab | Alt | GUI |Lower | Space |Raise | Left |Right | Up |Down |
+ `-----------------------------------------------------------------------------------'
+```
+
+## Lower
+```
+,-----------------------------------------------------------------------------------.
+ | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Del | F1 | F2 | F3 | F4 | F5 | F6 | _ | + | { | } | | |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | | F7 | F8 | F9 | F10 | F11 | F12 |ISO ~ |ISO | | Home | End | |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | | | | | | | | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------------------------------------------------'
+```
+
+## Raise
+```
+,-----------------------------------------------------------------------------------.
+ | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | Del | F1 | F2 | F3 | F4 | F5 | F6 | - | = | [ | ] | \ |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | | F7 | F8 | F9 | F10 | F11 | F12 |ISO # |ISO / |Pg Up |Pg Dn | |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | | | | | | | | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------------------------------------------------'
+```
+
+## Adjust
+`AGnorm` and `AGswap` switches `alt` and `os` key on the keyboard.
+```
+,-----------------------------------------------------------------------------------.
+ | | | | | | | | | | | | Del |
+ |------+------+------+------+------+-------------+------+------+------+------+------|
+ | | | | | |AGnorm|AGswap|Qwerty|Colemk| | | |
+ |------+------+------+------+------+------|------+------+------+------+------+------|
+ | | | | | | | | | | | | |
+ |------+------+------+------+------+------+------+------+------+------+------+------|
+ | | | | | | | | | | | |
+ `-----------------------------------------------------------------------------------'
+``` \ No newline at end of file