summaryrefslogtreecommitdiffstats
path: root/keyboard/ergodox_ez
diff options
context:
space:
mode:
authorAlex Johnstone <alexjj@gmail.com>2016-03-22 05:43:59 +0100
committerAlex Johnstone <alexjj@gmail.com>2016-03-22 05:43:59 +0100
commit4687162470673014cde3af4d3b72712c9a650955 (patch)
tree2d27b45e572375901ff435252c5bf041266ebec9 /keyboard/ergodox_ez
parentf6e5e2bd451340eda1f2d4b87e9ccbea035848d6 (diff)
downloadqmk_firmware-4687162470673014cde3af4d3b72712c9a650955.tar.gz
qmk_firmware-4687162470673014cde3af4d3b72712c9a650955.tar.xz
Added Readme
Diffstat (limited to 'keyboard/ergodox_ez')
-rw-r--r--keyboard/ergodox_ez/keymaps/alexjj/readme.md111
1 files changed, 111 insertions, 0 deletions
diff --git a/keyboard/ergodox_ez/keymaps/alexjj/readme.md b/keyboard/ergodox_ez/keymaps/alexjj/readme.md
new file mode 100644
index 000000000..07d149c9a
--- /dev/null
+++ b/keyboard/ergodox_ez/keymaps/alexjj/readme.md
@@ -0,0 +1,111 @@
+Englishman in New York
+===========================
+
+:microphone: :tea:
+
+About
+------
+
+After using the massdrop configurator to get the basics, I wanted to add a
+little extra to my ergodox. Notably the Hyper hotkey, the press and hold,
+and a way to have my beloved £ :pound: symbol available. Why not switch to a GB
+layout? Well the computers I use are US keymap'd and I can't always change
+that. Plus I've got used to 2/@ and 3/# and moving to the ergodox was hard
+enough. :sweat_smile:
+
+I started from the default and edited from there as I needed. It's somewhat
+similar to a regular layout, particularly R1 and shift/controls. I ended up
+with a few keys that were blank, so I'm testing out some shortcuts. Alt+F4 for
+quitting things in Windows, is one example, but I felt it was better placed on
+the 1st layer - in case of fat fingers.
+
+Layout
+-------
+
+*todo* insert picture
+
+### Base Layer
+
+```
+ ,--------------------------------------------------. ,--------------------------------------------------.
+ | ESC | 1 | 2 | 3 | 4 | 5 | 6 | | 7 | 8 | 9 | 0 | -_ | += | BkSp |
+ |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
+ | Tab | Q | W | E | R | T | { | | } | Y | U | I | O | P | |\ |
+ |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
+ | Win | A | S | D | F | G |------| |------| H | J | K | L | :; | '" |
+ |--------+------+------+------+------+------| Home | | End |------+------+------+------+------+--------|
+ | LShift |Z/Alt | X | C | V | B | | | | N | M | , | . |//Alt| RShift |
+ `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ |LCtrl | `~ | Hyper| Left | Right| | Up | Down | COPY | PASTE| RCtrl |
+ `----------------------------------' `----------------------------------'
+ ,-------------. ,-------------.
+ Meh = Ctrl+Alt+Shift | Alt | F5 | | F2 | +L1 |
+ ,------|------|------| |------+------+------.
+ | | | PgUp | | Ins | | |
+ | Enter| ~L2 |------| |------| ~L1 |Space |
+ | | | PgDn | | Del | | |
+ `--------------------' `--------------------'
+```
+
+### Symbol Layer
+
+```
+ ,--------------------------------------------------. ,--------------------------------------------------.
+ | | F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 |PrintScr|
+ |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
+ | | ! | @ | { | } | | | | | | Up | 7 | 8 | 9 | * | |
+ |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+ | | # | $ | ( | ) | ` |------| |------| Down | 4 | 5 | 6 | + | |
+ |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+ | | % | ^ | [ | ] | ~ | | | | & | 1 | 2 | 3 | \ | |
+ `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ | | £ | | | | | | . | 0 | = |Alt+F4|
+ `----------------------------------' `----------------------------------'
+ ^ ,-------------. ,-------------.
+ | | | | | | |
+ THERE! ,------|------|------| |------+------+------.
+ | | | | | | | |
+ | | |------| |------| | |
+ | | | | | | | |
+ `--------------------' `--------------------'
+```
+
+### Media Layer
+
+Not touched this, not used either.
+
+```
+ ,--------------------------------------------------. ,--------------------------------------------------.
+ | | | | | | | | | | | | | | | |
+ |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
+ | | | | MsUp | | | | | | | | | | | |
+ |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+ | | |MsLeft|MsDown|MsRght| |------| |------| | | | | | Play |
+ |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+ | | | | | | | | | | | | Prev | Next | | |
+ `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ | | | | Lclk | Rclk | |VolUp |VolDn | Mute | | |
+ `----------------------------------' `----------------------------------'
+ ,-------------. ,-------------.
+ | | | | | |
+ ,------|------|------| |------+------+------.
+ | | | | | | |Brwser|
+ | | |------| |------| |Back |
+ | | | | | | | |
+ `--------------------' `--------------------'
+```
+
+Changelog
+-----------
+
+### [0.0.1] - 2016-03-21
+
+First version
+
+
+Issues
+-------
+
+Space for feedback and notes for future improvements:
+
+