qmk_userspace/README.md
2024-10-16 00:20:31 +03:00

29 lines
834 B
Markdown

# QMK Keymap for the Iris CE
![](./docs/keymap_hrms.svg)
## How to use
This repository is a valid QMK external userspace as documented [here](https://docs.qmk.fm/newbs_external_userspace). To use it, you need:
1. QMK setup locally. See [QMK Docs](https://docs.qmk.fm/newbs_getting_started) for details
2. Clone this repository and add it as an overlay:
```
qmk config user.overlay_dir="/home/chzerv/qmk_keymap/"
```
3. To build the firmware:
```shell
qmk flash -kb keebio/iris_ce/rev1 -km chzerv
```
## TODO
- [ ] My symbol layer needs a bit more tweaking
- [x] Make my `Control/Escape` mod-tap send a one-shot `Ctrl` when held
# 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)