summaryrefslogtreecommitdiff
path: root/keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md
diff options
context:
space:
mode:
authorMario Arias <mario@marioarias.org>2019-07-30 16:13:08 +0800
committerDrashna Jaelre <drashna@live.com>2019-07-30 01:13:08 -0700
commita8427447bc2204df5a21372e129fcfa5ff87e634 (patch)
tree683687be5f260c0789b4032f58062fee6e053eef /keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md
parent046fb112598069879fd13a6a8eb68106316dcb6c (diff)
[Keymap] ErgoDox EZ Spanish Colemak (#6258)
* keyboard * documentation * address PR comments #1 * address PR comments #2
Diffstat (limited to 'keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md')
-rw-r--r--keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md b/keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md
new file mode 100644
index 0000000000..b17ae015aa
--- /dev/null
+++ b/keyboards/ergodox_ez/keymaps/colemak_es_osx/readme.md
@@ -0,0 +1,67 @@
+# ErgoDox EZ Spanish Colemak configuration
+
+## Description
+
+A Colemak keymap adapted for Spanish.
+
+### Base Layer - Spanish Colemak
+
+The Base Layer is a Colemak keymap with an additional "&ntilde;" next to the "y" key. The arrow cluster has a proper T inverted shape.
+
+It includes almost all Spanish Symbols from a normal 100% keyboard thanks to the use of tap keys
+
+
+| Pressed | Tap | Shift | Alt |
+|---|---|---|---|
+|Left Ctrl|PgDn|||
+|Left Alt|`|ˆ|[|
+|Left Cmd|+|*|]|
+|Right Cmd|´|¨|{|
+|Right Alt|ç|Ç|}|
+
+For example, if you want to type ```[]```, you keep pressing the "Left Alt" (To modify) and tap "Right Alt" and "Right Cmd" to send "[" and "]"
+
+### Qwerty Layer
+
+A Qwerty layer for gaming and maybe some VIM commands. It just modifies the few keys that are different between Colemak and Qwerty and keep all the others keys
+
+### Fn Layer
+
+A layer to change the number row including "º" and "¡" for "Fn1" to "Fn12". The rest is just the same as the Base layer
+
+### Mouse and media controls
+
+Mouse movement on the left hand, wheel and buttons on the right hand. "Play/Pause", "Rewind", "Forward" in the Left inner column. "Volume Up", "Volume Down" and "Mute" in the Right inner column
+
+### Numpad
+
+A complete numpad in the right hand, plus and Arrow cluster on the left hand
+
+### IDEA (JetBrains IDEs)
+
+A momentary layer for IDEA shortcuts that require more than two fingers or any Fn key
+
+## How to build it
+
+If you already have all the dependencies (Check QMK's documentation), you can run the command:
+
+```bash
+make ergodox_ez:colemak_es_osx
+```
+
+On MacOS, if you're using MacPorts you can install the following dependencies:
+
+```bash
+port install avr-binutils
+port install avr-gcc
+port install avr-libc
+```
+
+This isn't an exhaustive list and maybe there other dependencies that are technically necessary
+
+## Changelog
+
+* Jul 2019:
+ * Initial version for the new QMK version
+
+![](https://imgur.com/AyWNGlL.png) \ No newline at end of file