qmk_userspace/README.md
jasmine 657219d610
Update README with expanded feature descriptions
- Add detailed descriptions for each feature (Autocorrect, Combos, Home Row Mods, Repeat/Magic Keys)
- Resize and center images for better display on wide layouts
- Make keymap image collapsible by default
- Move Magic Sturdy reference to feature section
2025-10-14 18:21:10 +08:00

2.2 KiB

QMK Keymaps

ferris-sweep

Features

Autocorrect

Automatically fixes common typing mistakes in real-time. Maintains a dictionary of frequently mistyped words and corrects them as you type, reducing the need for manual backspacing and retyping.

Combos

Press multiple keys simultaneously to output different characters or trigger actions. Enables access to numbers, symbols, and commands without leaving the home position, reducing finger travel and improving typing efficiency.

Home Row Mods

Modifier keys (Alt, Shift, GUI, Ctrl) placed on the home row as dual-function keys. Tap for the letter, hold for the modifier. Eliminates the need to reach for traditional modifier positions, reducing hand movement and strain.

Repeat / Magic Keys

Two intelligent repeat mechanisms on the thumb keys:

  • Repeat Key - Repeats the last keystroke with context-aware enhancements for common trigrams and word briefs
  • Magic Key - Context-aware completions based on the previous key. Reduces same-finger bigrams and enables common word completions

See magic sturdy for the inspiration behind the magic key implementation.

My Keymap

View Keymap
ferris-keymap

Installation

Follow the getting started docs to install QMK Firmware

# Clone the keymaps
git clone https://git.sajenim.dev/jasmine/qmk_userspace.git
    
# Setup external userspace
qmk config user.overlay_dir="$(realpath qmk_userspace)"

# Compile the firmware
qmk compile -kb <keyboard> -km <keymap>

References