diff --git a/README.md b/README.md index 372e323..917e7fa 100644 --- a/README.md +++ b/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 `/keyboards/crkbd/keymaps/` + + +### Compile keymaps + +```console +$ cd +$ qmk compile -kb crkbd -km inkch +``` + +### Flash keymaps to `crkbd` + +```console +$ cd +$ qmk flash -kb crkbd -km inkch -bl avrdude-split-left +$ qmk flash -kb crkbd -km inkch -bl avrdude-split-right +```