summaryrefslogtreecommitdiff
path: root/layouts/community/ergodox/berfarah/readme.md
diff options
context:
space:
mode:
authorBernardo Farah <ber@bernardo.me>2017-10-24 19:08:31 -0700
committerJack Humbert <jack.humb@gmail.com>2017-10-24 16:59:35 -1000
commit4c960ad7c4b109dda8ddcb5ffe1d2f7e674f8f91 (patch)
tree9e9c0e802d3eef3243fd1cfd2dfaee41f4330866 /layouts/community/ergodox/berfarah/readme.md
parenta08287b0a0800e0add34fa9c0c4916d2bf8d5db1 (diff)
Added berfarah's custom keyboard layout
Diffstat (limited to 'layouts/community/ergodox/berfarah/readme.md')
-rw-r--r--layouts/community/ergodox/berfarah/readme.md93
1 files changed, 93 insertions, 0 deletions
diff --git a/layouts/community/ergodox/berfarah/readme.md b/layouts/community/ergodox/berfarah/readme.md
new file mode 100644
index 0000000000..ccdcb91fbe
--- /dev/null
+++ b/layouts/community/ergodox/berfarah/readme.md
@@ -0,0 +1,93 @@
+# Bernardo's modified version of the OSX defaults
+
+I map F19 to spotlight so I like having that handy
+
+## Base
+
+
+```
+ ,--------------------------------------------------. ,--------------------------------------------------.
+ | | | | | | | | | Power| | | | | | |
+ |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
+ | Tab | Q | W | E | R | T | [ | | ] | Y | U | I | O | P | \ |
+ |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+ |Ctrl/Esc| A | S | D | F | G |------| |------| H | J | K | L |;/MOVE| ' |
+ |--------+------+------+------+------+------| ( | | ) |------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | B | | | | N | M | , | . | / | RShift |
+ `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ |Hyper | F19 |AltShf| | NUMS | | NUMS | |Ctrl/E| F19 | Meh |
+ `----------------------------------' `----------------------------------'
+ ,-------------. ,-------------.
+ | V- | V+ | | Next |Play/Pau|
+ ,------|------|------| |------+--------+------.
+ | | | Vx | | Prev | | |
+ | Space| LGUI |------| |------| Bsp | Enter|
+ | | | LAlt | | LAlt | | |
+ `--------------------' `----------------------'
+```
+
+## Numbers and Symbols
+
+
+```
+,--------------------------------------------------. ,--------------------------------------------------.
+| | F1 | F2 | F3 | F4 | F5 | | | | F6 | F7 | F8 | F9 | F10 | |
+|--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
+| ⌘-` | ` | | | | | | | | | | | - | = | |
+|--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+| | 1 | 2 | 3 | 4 | 5 |------| |------| 6 | 7 | 8 | 9 | 0 | |
+|--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+| | F11 | F12 | F13 | F14 | F15 | | | | F16 | F17 | F18 | F19 | F20 | |
+`--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ | | | | | | | | | | | |
+ `----------------------------------' `----------------------------------'
+ ,-------------. ,-------------.
+ | | | | | |
+ ,------|------|------| |------+------+------.
+ | | | | | | | |
+ | | |------| |------| | |
+ | | | | | | | |
+ `--------------------' `--------------------'
+```
+
+## Movement
+
+```
+,--------------------------------------------------. ,--------------------------------------------------.
+| | | | | | | | | | | | | | | |
+|--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
+| | | ⌥ ← | | | | | | | ⌘ ← | ⌥ ← | ⌥ → | ⌘ → | | |
+|--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+| | | HOME | PGUP | PGDW | END |------| |------| ← | ↓ | ↑ | → | | |
+|--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
+| | | | | | ⌥ → | | | | | | | | | |
+`--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
+ | | | | | | | | | | | |
+ `----------------------------------' `----------------------------------'
+ ,-------------. ,-------------.
+ | | | | | |
+ ,------|------|------| |------+------+------.
+ | | | | | | | |
+ | | |------| |------| | |
+ | | | | | | | |
+ `--------------------' `--------------------'
+```
+
+## Building
+
+In order to be able to make frequent updates, I maintain this layout [in its own
+repository](berfarah:ergodox-layout)
+
+```sh
+git clone https://github.com/qmk/qmk_firmware.git
+cd qmk_firmware
+git clone https://github.com/berfarah/ergodox-layout.git \
+ layouts/community/ergodox/berfarah_master
+make ergodox_ez-berfarah_master
+```
+
+To use this keyboard, run `make ergodox_ez:berfarah`
+
+## Using on Windows
+
+The keymap default to forcing NKRO, which seems to upset Windows, and except the modifiers, none of them work. If you experience this problem, recompile the firmware with `FORCE_NKRO=no` added to the `make` command line.