qmk_keymaps/README.md

30 lines
806 B
Markdown
Raw Normal View History

2023-07-25 12:32:12 +08:00
# QMK Keymaps
2023-01-06 02:14:35 +08:00
2024-08-05 22:28:21 +08:00
Personal keymaps for programmable keyboards.
2023-07-25 12:32:12 +08:00
2024-08-05 22:28:21 +08:00
## Features
* **Autocorrect**
2024-10-27 06:56:29 +08:00
* **Combos**
2024-08-05 22:28:21 +08:00
* **Home Row Mods**
2024-10-27 06:56:29 +08:00
* **Nav, Num, Fun Layers**
* **Repeat / Magic Keys**
2023-07-25 12:32:12 +08:00
2024-08-05 22:28:21 +08:00
## Installation
2023-07-25 12:32:12 +08:00
Follow the [getting started](https://docs.qmk.fm/#/newbs_getting_started) docs to install [QMK Firmware](https://docs.qmk.fm/#/)
2024-08-05 22:28:21 +08:00
```sh
# Clone the keymaps
git clone https://git.sajenim.dev/jasmine/qmk_keymaps.git
2023-07-25 12:32:12 +08:00
2024-08-05 22:28:21 +08:00
# Merge our keymaps into qmk_firmware
rsync --recursive qmk_keymaps/keyboards/ qmk_firmware/keyboards/
# Compile the firmware
qmk compile -kb <myKeyboard> -km <myKeymap>
```
## References
* [Precondition](https://precondition.github.io/home-row-mods)
* [Pascal Getreuer](https://getreuer.info/posts/keyboards/index.html)
2024-10-27 06:56:29 +08:00
* [Ikcelaks](https://github.com/Ikcelaks/keyboard_layouts/tree/main)