diff options
Diffstat (limited to 'layouts/community/ergodox/familiar/README.md')
| -rw-r--r-- | layouts/community/ergodox/familiar/README.md | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/layouts/community/ergodox/familiar/README.md b/layouts/community/ergodox/familiar/README.md deleted file mode 100644 index 8d68af21a..000000000 --- a/layouts/community/ergodox/familiar/README.md +++ /dev/null | |||
| @@ -1,69 +0,0 @@ | |||
| 1 | # ErgoDox Familiar Layout | ||
| 2 | Familiar layout for those who regularly switch back and forth from ErgoDox to "normal" QWERTY. | ||
| 3 | |||
| 4 | [](../../../../license_GPLv3.md) [](https://github.com/RichardLitt/standard-readme) | ||
| 5 | |||
| 6 | ## Table of Contents | ||
| 7 | |||
| 8 | - [Background](#background) | ||
| 9 | - [Install](#install) | ||
| 10 | - [Usage](#usage) | ||
| 11 | - [Layers](#layers) | ||
| 12 | - [Contribute](#contribute) | ||
| 13 | - [Issues](#issues) | ||
| 14 | - [License](#license) | ||
| 15 | |||
| 16 | ## Background | ||
| 17 | |||
| 18 | This layout is built to be as familiar as possible for users coming directly from a default (QWERTY US) keyboard, while gaining as much advantage as possible from the ErgoDox and QMK featureset. I use an ErgoDoxEZ at home, but I don't have a regular office (CS grad student) so I regularly use either my laptop or a default-setup lab computer; I context switch daily so this layout is meant to reduce the mental overhead as much as possible. | ||
| 19 | |||
| 20 | The default ErgoDoxEZ layout is probably more optimized as a solo daily driver - as are a lot of the others available keymaps. The focus of this layout is to get as much from the 'Dox as possible without overly disrupting long-established muscle memory. | ||
| 21 | |||
| 22 | Key features of the familiar layout: | ||
| 23 | 1. QWERTY default layout. | ||
| 24 | 1. International symbols layer, mapped in the US-International layout default positions, through [UCIS](https://github.com/qmk/qmk_firmware/wiki/Unicode-and-additional-language-support#ucis_enable). | ||
| 25 | 1. Numpad layer on right hand. | ||
| 26 | 1. Thumb cluster holds spacebar and access to secondary layers. | ||
| 27 | 1. Function-layer arrow keys in both the first-person-shooter (actually ESDF instead of WASD) and vim (HJKL) locations. | ||
| 28 | |||
| 29 | ## Install | ||
| 30 | |||
| 31 | If you are on Windows or Mac, choose the proper line in [`keymap.c`](keymap.c) for [unicode/international character support](https://github.com/qmk/qmk_firmware/wiki/Unicode-and-additional-language-support#ucis_enable) (starts at line 253). | ||
| 32 | ```c | ||
| 33 | void matrix_init_user(void) { | ||
| 34 | set_unicode_input_mode(UC_LNX); // Linux | ||
| 35 | //set_unicode_input_mode(UC_OSX); // Mac OSX | ||
| 36 | //set_unicode_input_mode(UC_WIN); // Windows (with registry key, see wiki) | ||
| 37 | //set_unicode_input_mode(UC_WINC); // Windows (with WinCompose, see wiki) | ||
| 38 | }; | ||
| 39 | ``` | ||
| 40 | |||
| 41 | For instructions on building and installing this keymap, [go to the wiki](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ergodox#build-dependencies). Below is the command for me; it may be different for you. | ||
| 42 | ```sh | ||
| 43 | $ make ergodox-ez-familiar-teensy | ||
| 44 | ``` | ||
| 45 | |||
| 46 | ## Usage | ||
| 47 | |||
| 48 | [](https://gist.github.com/nstickney/13508a9f99cff381d58b7be6f7dcc644) | ||
| 49 | |||
| 50 | ### Layers | ||
| 51 | 1. Base Layer: QWERTY, with arrow keys at bottom right. | ||
| 52 | 1. UCIS Layer: US-International symbols layer, plus —. Accessed by toggling the `SYMB` layer using the UCIS key (bottom of left thumb cluster). | ||
| 53 | 1. UCIS-Shifted Layer: Making shift work for UCIS characters. An ugly workaround. Any ideas? Accessed by holding shift while the `SYMB` layer is active (toggles the `CSYM` layer). | ||
| 54 | 1. Numpad Layer: Right hand number pad. Accessed by toggling the `NUMP` layer using the NUMP key (bottom of right thumb cluster). | ||
| 55 | 1. Function Layer: F1-F12, arrows on ESDF and HJKL, media player controls. Accessed by holding either FN key (center key of each thumb cluster), which toggles the `ARRW` layer. I know, I need to work on my naming conventions. | ||
| 56 | |||
| 57 | ## Contribute | ||
| 58 | |||
| 59 | [Contributor Covenant](http://contributor-covenant.org/) | ||
| 60 | |||
| 61 | I'm terrible at this; I have no background in human-computer interaction, kinesiology, or keyboard-ology. Please send comments/issues/pull requests/angry tweets/etc. If you think there is a better way to take advantage of the ErgoDox/QMK comination without straying far from 84/101-key QWERTY, I want to know it. | ||
| 62 | |||
| 63 | ### Issues | ||
| 64 | 1. The `CSYM` layer is an ugly workaround. I should write a function for doing different things in the `SYMB` layer depending on whether SHIFT is being held. Or something. Ideas? | ||
| 65 | 1. Right now, the thumb cluster function keys double as slash and whack... this really isnt a great solution. | ||
| 66 | 1. `MENU` and `LEAD` are useless, at the moment. | ||
| 67 | |||
| 68 | ## License | ||
| 69 | QMK is licensed ([mostly](https://github.com/qmk/qmk_firmware/issues/1038)) under the [GPLv2](../../../../license_GPLv2.md). Accordingly, to whatever extent applicable, this keymap is licensed under the [GPLv3](../../../../license_GPLv3.md). | ||
