diff --git a/README.md b/README.md index 8077d71b..f039f9b9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # QMK Keymap for the Iris CE -![](./docs/keymap_hrms.svg) +## Layout summary + +Most functionality is spread across three layers: + +1. `Base`: Pretty basic QWERTY layer with the `GUI`, `Bspc`, `Enter`, `Spc` and `Alt` keys moved to the thumb cluster. +2. `Navigation`: Focuses on moving around. + - Utilizes One Shot Modifiers on the left home row so we can easily do stuff like `Ctrl + Right` + - Utilizes macros for quickly selecting/extending words and lines + - Shortcuts for browser tab manipulation +3. `Symbols`: My symbol layer, inspired by [sunaku's symbol layer](https://sunaku.github.io/moergo-glove80-keyboard.html#symbol-layer) and [getruer's symbol layer](https://getreuer.info/posts/keyboards/symbol-layer/index.html#my-symbol-layer) + - Symbols on the left hand home row are placed in a way that favors Vim usage + - Parentheses and brackets are grouped on the right hand + +We have also implemented a `function` layer as a [Tri Layer](https://docs.qmk.fm/features/tri_layer), which is used for less common keys, such as media and RGB controls, accessing the keyboard's bootloader, F-keys etc. ## How to use @@ -46,8 +59,9 @@ This repository is a valid QMK external userspace as documented [here](https://d - Turns out this causes more trouble than it solves: - `Ctrl + Mouse` doesn't work - `Ctrl` only applies to the first key, which makes shortcuts like deleting backwards in the shell using `Ctrl+h` feel very awkward, as you have to keep pressing `Ctrl` +- [ ] Add [X-Case](https://github.com/andrewjrae/kyria-keymap?tab=readme-ov-file#x-case) -# Credits +## Credits - [Pascal Getreuer's QMK keymap](https://github.com/getreuer/qmk-keymap/tree/main) - [Sunaku's "Glorious Engrammer" keymap](https://github.com/sunaku/glove80-keymaps)