diff --git a/README.md b/README.md index 25c1020..2ea31de 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,29 @@ KiCAD files for the PCB of mkbd65. ## Firmware -1. Get the QMK firmware from [here](https://gitlab.com/mkbd65/qmk-firmware) -2. Checkout the `mkbd65` branch -3. Flash firmware with (change `ansi` to `iso` for different layout): +1. Get the QMK firmware ```shell - make mkbd65:ansi + git clone https://gitlab.com/mkbd65/qmk-firmware.git + ``` +2. Checkout the `mkbd65` branch + ``` + cd mkbd65 + git checkout mkbd65 + ``` +3. Install qmk tool + ```shell + # arch linux + sudo pacman -S qmk + # others + python3 -m pip install --user qmk + ``` +4. Setup qmk environment + ```shell + qmk setup + ``` +3. Flash firmware (change `ansi` to `iso` for different layout): + ```shell + qmk flash -kb mkbd65 -km ansi ``` You can find the code for the keyboard [here](https://gitlab.com/mkbd65/qmk-firmware/-/tree/mkbd65/keyboards/mkbd65).