This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.
Clone repository with submodules and add upstream remote
git clone --recurse-submodules https://github.com/liraymond04/qmk_firmware.git
git remote add upstream https://github.com/qmk/qmk_firmware.git
Install avr-gcc 8 and the qmk package from pacman
sudo pacman -U https://archive.archlinux.org/packages/a/avr-gcc/avr-gcc-8.3.0-1-x86_64.pkg.tar.xz
sudo pacman -S qmk
Run qmk doctor to check requirements
qmk setup
Set build environment defaults
qmk config user.keyboard=xiudi/xd84pro
qmk config user.keymap=liraymond04
Run qmk command to compile firmware
qmk compile
Flashing options:
- Hold down both shift keys and press Pause
- Hold down both shift keys and press B
- Unplug your keyboard, hold down the Spacebar and B at the same time, plug in your keyboard and wait a second before releasing the keys
- 》 Unplug your keyboard, hold down the top or bottom left key (usually Escape or Left Control) and plug in your keyboard
- Press the physical RESET button, usually located on the underside of the PCB
- Locate header pins on the PCB labeled RESET and GND, and short them together while plugging your PCB in
Run qmk command to flash firmware
qmk flash
The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.
You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.
The project also includes community support for lots of other keyboards.
QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.
qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.