qmk-keychron-q3-colemak-dh/keyboards/kc60/keymaps/noroadsleft/readme_ch1.md
noroadsleft ce465c084b Updates to noroadsleft keymap for KC60 (#5127)
* NUBS_Z: initial version

Create a keycode that is normally Z, but KC_NUBS when tapped while Alt is being held.

This removes the possibility of using an Alt+Z shortcut.

* NUBS_Z: modification

Modify NUBS_Z macro to only use alternate operation if Right Alt is being held, rather than responding to either Alt key.

Also add QMK version keycode to System layer, Equals key.

* Remove unneeded breaks from process_record_user

* Macro refactoring

- removed G_RST and G_C10R macros
- updated G_BRCH macro
  - outputs `master` if used while Shift is held down; or my git alias for the current branch otherwise
- updated G_FTCH macro
  - outputs `git pull upstream ` if used with Shift; `git fetch upstream ` otherwise
- swapped `modifiers` variable for `get_mods()` function directly for checking modifier state
- swapped keymap-level modifier mask macros for QMK-core mod mask macros (thanks vomindoraan #4337)
- renamed MODS_RALT_MASK to MOD_MASK_RALT (more consistent with the above change)

* Update readme files
2019-02-14 07:07:32 -08:00

69 lines
2.9 KiB
Markdown

# @noroadsleft's KC60 keymap
- [Table of Contents](./readme.md)
1. **Base Layers**
2. [**OS Overlays**](./readme_ch2.md)
3. [Quake 2 Overlays](./readme_ch3.md)
4. [Function Layers](./readme_ch4.md)
5. [Other Layers](./readme_ch5.md)
----
## Layer 0: QWERTY - `_QW`
Standard QWERTY layout, with three QMK features:
- The `Menu` key has been replaced by `MO(_FW)`, which moves to my Windows Fn layer when held.
- The `Caps Lock` key has been replaced with a dual function `LT()` key, which opens the Windows Fn layer when held, and is `Caps Lock` when tapped
- The `Escape` key has been replaced with a `KC_GESC` `` ` ~ `` key when used with a `Fn` key or a `Shift` key
###### For the rest of this readme, the physical location of keys will be referred to by their function in a US QWERTY layout.
![QWERTY layer](https://i.imgur.com/2eVsefw.png)
Keycode(s) Sent | Notes
:---------------------------------------------------- | :----
[`KC_GESC`](https://docs.qmk.fm/#/feature_grave_esc) | `Esc` when tapped alone, `` ` ~ `` when used with a `Shift` or `GUI` key.
`LT(_FW, KC_CAPS)` | Opens the Windows Fn layer when held; toggles Caps Lock when tapped.
`MO(_FW)` | Opens the Windows Fn layer when held.
----
## Layer 1: Hardware Dvorak - `_DV`
### Accessed by holding either `Fn` and tapping `/?` key, then tapping `2@`.
A hardware-based Dvorak Simplified layout. At my weekend job, I use a shared computer that runs MacOS Sierra, in US QWERTY layout. In this layer, I can leave the system in QWERTY, plug my keyboard in, and still type in Dvorak.
![Hardware Dvorak layer](https://i.imgur.com/a6hYedB.png)
Keycode(s) Sent | Notes
:---------------------------------------------------- | :----
[`KC_GESC`](https://docs.qmk.fm/#/feature_grave_esc) | `Esc` when tapped alone, `` ` ~ `` when used with a `Shift` or `GUI` key.
`LT(_FW, KC_CAPS)` | Opens the Windows Fn layer when held; toggles Caps Lock when tapped.
`MO(_FW)` | Opens the Windows Fn layer when held.
----
## Layer 2: Hardware Colemak `_CM`
### Accessed by holding either `Fn` and tapping `/?` key, then tapping `3#`.
A hardware-based Colemak layout. Been thinking of trying it, so it's here.
![Hardware Colemak layer](https://i.imgur.com/dbQ6HDW.png)
Keycode(s) Sent | Notes
:---------------------------------------------------- | :----
[`KC_GESC`](https://docs.qmk.fm/#/feature_grave_esc) | `Esc` when tapped alone, `` ` ~ `` when used with a `Shift` or `GUI` key.
`LT(_FW, KC_CAPS)` | Opens the Windows Fn layer when held; toggles Caps Lock when tapped.
`MO(_FW)` | Opens the Windows Fn layer when held.
----
Next Chapter: [OS Overlays](./readme_ch2.md)