keyboards/keebio/iris/keymaps/nstickney/README.md

   1 # nstickney's Iris Layout
   2
   3  > Familiar layout for users who regularly switch between Iris and more standard layouts.
   4
   5 [![Keymap](https://i.imgur.com/hKs7fYr.jpg)](http://www.keyboard-layout-editor.com/#/gists/aa6093ea2eb9c750ab941b92adae7036)
   6
   7 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
   8
   9 ## Install
  10
  11 For instructions on building and installing this keymap, see the [docs](https://docs.qmk.fm/#/getting_started_make_guide). Below is the command for me; it may be different for you.
  12
  13 ```sh
  14 $ make keebio/iris/rev2:nstickney:avrdude
  15 ```
  16
  17 ## Usage
  18
  19 0. QWERTY `BASE` layer.
  20         * `/`, `\`, ` `, `[ENTER]`, `-`, and `=` on the thumb clusters.
  21         * `CAPSLOCK` replaced by `ESC`; hold it down for `CTRL`. `'` can also be held for `CTRL`.
  22         * [Space-Cadet Shift](https://docs.qmk.fm/#/feature_space_cadet_shift) is enabled, so the `SHIFT` keys send `(` and `)` when tapped.
  23         * Hold down `/` or `=` for `ALT`.
  24         * Hold down `\` or `-` to access the functions layer.
  25         * Upper-center thumb keys are `GUI` and `MENU`.
  26                 * Tapping `GUI` 2, 3, or 4 times will toggle `NUMLOCK`, `CAPSLOCK`, or `SCROLLLOCK`, respectively.
  27                 * Tapping `MENU` 2, 3, or 4 times will toggle the `NUMP`, `SYMB`, and `SYSH` layers, respectively.
  28 0. Unicode-input symbols on `SYMB` and `SYSH` layers. Based (loosely) on US-International layout.
  29 0. `NUMP` layer has number pads on each hand. Number pad `7`-`8`-`9` align with QWERTY `7`-`8`-`9` on right hand.
  30 0. Function, arrow, media, and miscellaneous keys on `FCTN` layer.
  31         * `F1` through `F10` on `1`-`10`. `F11` is on `GUI` and `F12` is on `MENU`.
  32         * Brackets (`[` and `]`) available on `U` and `I`; braces (`{` and `}`) on `O` and `P`.
  33         * Arrow keys on `ESDF` and `HJKL`; familiar for both Vim users and FPS gamers.
  34         * `W` is `HOME`; `R` is `END`. `T` is `PAGE UP` and `G` is `PAGE DOWN`.
  35         * Music controls on lower row of left hand.
  36         * Volume and screen brightness on lower row of right hand.
  37         * `PRINT SCREEN`, `PAUSE`, `SYSREQ`, `INSERT`, and `CLEAR` also mapped, as intelligently as possible.
  38         * `A` toggles the RGB underglow (which changes color to indicate active layer).
  39         * `Q` toggles the Unicode input through Linux, WinCompose, and MacOS.
  40
  41 ## Contribute
  42
  43 If you are using this layout and think you've found a better way to do something, I'd appreciate an [issue](https://github.com/nstickney/qmk_firmware/issues), or better yet a [pull request](https://github.com/nstickney/qmk_firmware/pulls).
  44
  45 ## License
  46
  47 Copyright &copy; 2016-2019 @nstickney. Released under [GPL-2.0](/LICENSE).