inkch/inkch-crkbd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add instructions for compiling and flashing keymaps to README

Browse Source
This commit is contained in:
inkch 2024-08-23 16:50:00 +09:00
parent c801962c6e
commit fa7b4f0038
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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
```