Add instructions for compiling and flashing keymaps to README
This commit is contained in:
parent
c801962c6e
commit
fa7b4f0038
18
README.md
18
README.md
@ -16,6 +16,24 @@ manageable and easy to maintain.
|
||||
|
||||
## How to use
|
||||
|
||||
### Prepare
|
||||
|
||||
1. Pull [`qmk/qmk_firmware`](https://github.com/qmk/qmk_firmware)
|
||||
2. [Set up QMK Env](https://docs.qmk.fm/newbs_getting_started)
|
||||
3. Clone this repo into `<qmk_firmware root>/keyboards/crkbd/keymaps/`
|
||||
|
||||
|
||||
### Compile keymaps
|
||||
|
||||
```console
|
||||
$ cd <qmk_firmware root>
|
||||
$ qmk compile -kb crkbd -km inkch
|
||||
```
|
||||
|
||||
### Flash keymaps to `crkbd`
|
||||
|
||||
```console
|
||||
$ cd <qmk_firmware root>
|
||||
$ qmk flash -kb crkbd -km inkch -bl avrdude-split-left
|
||||
$ qmk flash -kb crkbd -km inkch -bl avrdude-split-right
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user