summaryrefslogtreecommitdiff
path: root/users/nstickney/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2021-08-09 12:14:22 -0700
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2021-08-09 12:14:22 -0700
commit7bec943043b8d03482e9f4ffc69cc63b9fc4a18a (patch)
treee138b4d121f2196d3983e1643cab4381ee729c9b /users/nstickney/readme.md
parentc0628c2820b436550f62af5f6b7fae1f66b0bf8b (diff)
parent26ea090190b815862f108903e5f41f20c6d16d66 (diff)
Merge remote-tracking branch 'upstream/master' into develop
Fixes merge conflicts in: - keyboards/bm40hsrgb/config.h - Conflict from PR 13132: - RGB_DISABLE_WHEN_USB_SUSPENDED signature updated in develop branch, unmodified in master branch - updated file with changes from master branch - keyboards/keebio/iris/keymaps/nstickney/keymap.c - Conflict from PR 11456: - layer_state_set_user() updated in develop branch, removed in master branch - updated file with changes from master branch
Diffstat (limited to 'users/nstickney/readme.md')
-rw-r--r--users/nstickney/readme.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/users/nstickney/readme.md b/users/nstickney/readme.md
new file mode 100644
index 0000000000..b62264d687
--- /dev/null
+++ b/users/nstickney/readme.md
@@ -0,0 +1,49 @@
+# nstickney's Ortholinear Layout
+
+ > Familiar layout for users who regularly switch between Bastyl/Iris and standard QWERTY.
+
+## Install
+
+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.
+Note that my Iris keyboard has an Elite-C on the left half and a ProMicro on the right half.
+
+- Bastyl: `make hidtech/bastyl:nstickney:dfu`
+- Iris
+ - Elite-C: `make keebio/iris/rev2:nstickney:dfu`
+ - ProMicro: `make keebio/iris/rev2:nstickney:avrdude`
+
+## Usage
+
+0. QWERTY `BASE` layer.
+ * `/`, `\`, `[SPACE]`, `[ENTER]`, `-`, and `=` on the thumb clusters.
+ * `[` and `]` added on Bastyl.
+ * `CAPSLOCK` replaced by `ESC`; hold it down for `CTRL`.
+ * `'` can also be held for `CTRL`.
+ * [Space-Cadet Shift](https://beta.docs.qmk.fm/using-qmk/advanced-keycodes/feature_space_cadet) is enabled, so the `SHIFT` keys send `(` and `)` when tapped.
+ * Hold down `/` or `=` for `ALT`.
+ * Hold down `\` or `-` to access the functions layer.
+ * Farthest thumb keys are `GUI` (left) and `MENU` (right).
+ * Tapping `GUI` 2, 3, or 4 times will toggle `NUMLOCK`, `CAPSLOCK`, or `SCROLLLOCK`, respectively.
+ * Tapping `MENU` 2 or 3 times will toggle the `NUMP` and `SYMB` layers, respectively.
+0. Unicode-input symbols on `SYMB` layer. Based (loosely) on US-International layout.
+0. `NUMP` layer has number pads on each hand. Number pad `7`-`8`-`9` align with QWERTY `7`-`8`-`9` on right hand.
+0. Function, arrow, media, and miscellaneous keys on `FCTN` layer.
+ * `F1` through `F10` on `1`-`10`. `F11` is on `GUI` and `F12` is on `MENU`.
+ * Brackets (`[` and `]`) available on `U` and `I`; braces (`{` and `}`) on `O` and `P`.
+ * Arrow keys on `ESDF` and `HJKL`; familiar for both Vim users and FPS gamers.
+ * `W` is `HOME`; `R` is `END`. `T` is `PAGE UP` and `G` is `PAGE DOWN`.
+ * Music controls on lower row of left hand.
+ * Volume and screen brightness on lower row of right hand.
+ * `PRINT SCREEN`, `PAUSE`, `SYSREQ`, `INSERT`, and `CLEAR` also mapped, as intelligently as possible.
+ * `Q` toggles the RGB underglow (which changes color to indicate active layer).
+ * `A` increases RGB underglow brightness (with `SHIFT`, decreases brightness).
+ * `Y` is mapped to [`KC_LOCK`](https://beta.docs.qmk.fm/using-qmk/software-features/feature_key_lock).
+
+## Contribute
+
+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).
+
+## License
+
+Copyright &copy; 2016-2021 @nstickney. Released under [GPL-2.0](/LICENSE).