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
This commit is contained in:
♥ Minnie ♥ 2025-10-14 18:21:10 +08:00
parent e0bfafecc7
commit 657219d610
Signed by: jasmine
GPG key ID: 8563E358D4E8040E

View file

@ -1,19 +1,37 @@
# QMK Keymaps
![ferris-sweep](./assets/img/keyboards/ferris-sweep.jpg)
<div align="center">
<img src="./assets/img/keyboards/ferris-sweep.jpg" width="70%" alt="ferris-sweep">
</div>
## Features
* **Autocorrect**
* **Case Modes**
* **Combos**
* **Home Row Mods**
* **Leader Key**
* **Repeat / Magic Keys**
### 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**](https://github.com/Ikcelaks/keyboard_layouts/blob/main/magic_sturdy/magic_sturdy.md) for the inspiration behind the magic key implementation.
## My Keymap
![ferris-keymap](./assets/img/keymaps/ferris-sajenim.svg)
See [**magic sturdy**](https://github.com/Ikcelaks/keyboard_layouts/blob/main/magic_sturdy/magic_sturdy.md) for usage of the magic key.
<details>
<summary>View Keymap</summary>
<div align="center">
<img src="./assets/img/keymaps/ferris-sajenim.svg" width="70%" alt="ferris-keymap">
</div>
</details>
## Installation
Follow the [getting started](https://docs.qmk.fm/#/newbs_getting_started) docs to install [QMK Firmware](https://docs.qmk.fm/#/)