Simplified QMK firmware building guide

README.md

Prerequisite

• Podman or Docker
• Git

Clone the repository with all the submodules

$ git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git

Create your keymap

$ cd qmk_firmware
$ util/docker_cmd.sh qmk new-keymap -kb <YOUR_KEYBOARD_NAME> -km <YOUR_KEYMAP_NAME>

Get your keymap.json from config.qmk.fm or from scratch

You will then put this file under qmk_firmware/keyboards/<YOUR_KEYBOARD_NAME>/<YOUR_KEYMAP_NAME>/keymap.json

Optional Customize settings via rules.mk or config.h

Create rules.mk, and config.h under qmk_firmware/keyboards/<YOUR_KEYBOARD_NAME>/<YOUR_KEYMAP_NAME>/keymap.json

Customize your build by referring to config options from QMK docs

Compile your firmware

$ util/docker_build.sh <YOUR_KEYBOARD_NAME>:<YOUR_KEYMAP_NAME>

Flash your keyboard, and profit