blob: 6fa7d22bb75d9564c96ced1e46bb31020b0a305c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
# Ruben's QMK Keymaps
This repository hosts my qmk keymaps. It includes keymaps for the keyboards I
use:
- Anne Pro 2 (C18)
- Keychron Q3 with dial.
## Set up
1. Run `qmk setup` procedure if you haven't already done so -- see the
[QMK Docs](https://docs.qmk.fm/#/newbs) for details.
2. Clone this repository
3. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"`
## Create New Keymap
Run `qmk new-keymap -kb <your_keyboard> -km <your_keymap>` to create the new
directory.
* A new Q3 keymap: `qmk new-keymap -kb keychron/q3/ansi_encoder -km new_rbdr`
* A new Anne Pro 2 keymap: `qmk new-keymap -kb annepro2/c18 -km new_rbdr`
## Adding a keymap
Register your keymaps:
* Q3 + rbdr: `qmk userspace-add -kb keychron/q3/ansi_encoder -km rbdr`
* AnnePro2 + rbdr: `qmk userspace-add -kb annepro2/c18 -km rbdr`
## Build / Flash
Assuming you ran setup as above, and you registered the keymaps, you can then
use `qmk compile` or `qmk flash`.
* Flash the Q3 with rbdr: `qmk flash -kb keychron/q3/ansi_encoder -km rbdr`
* Flash the Anne Pro 2 with rbdr: `qmk flash -kb annepro2/c18 -km rbdr`
You can also use `make keychron/q3/ansi_encoder:rbdr` or `make annepro2/c18:rbdr`.
Alternatively, if you configured your build targets above, you can use
`qmk userspace-compile` to build all of your userspace targets at once.
|
