Go to file
Nick Brassel 1de39e5632 Define STM32_DMA_REQUIRED when using DMA-based WS2812 driver on STM32. (#10127) 2020-08-29 14:30:02 -07:00
.github
.vscode
bin
docs Add a method to read the OLED display buffer from user space (#8777) 2020-08-29 14:30:02 -07:00
drivers Add a method to read the OLED display buffer from user space (#8777) 2020-08-29 14:30:02 -07:00
keyboards Define STM32_DMA_REQUIRED when using DMA-based WS2812 driver on STM32. (#10127) 2020-08-29 14:30:02 -07:00
layouts
lib Update vusb to match 3rd endpoint. (#9020) 2020-08-29 14:30:02 -07:00
platforms/chibios Remove unused CORTEX_VTOR_INIT (#10053) 2020-08-29 14:30:02 -07:00
quantum Kiibohd bootloader, take 2 (#10129) 2020-08-29 14:30:02 -07:00
tests
tmk_core Kiibohd bootloader, take 2 (#10129) 2020-08-29 14:30:02 -07:00
users Better handle LTO_ENABLE (#9832) 2020-08-29 14:30:02 -07:00
util
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
book.json
bootloader.mk Kiibohd bootloader, take 2 (#10129) 2020-08-29 14:30:02 -07:00
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk Define STM32_DMA_REQUIRED when using DMA-based WS2812 driver on STM32. (#10127) 2020-08-29 14:30:02 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk Better handle LTO_ENABLE (#9832) 2020-08-29 14:30:02 -07:00
testlist.mk

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

THIS IS THE DEVELOP BRANCH

Warning- This is the develop branch of QMK Firmware. You may encounter broken code here. Please see Breaking Changes for more information.

Original readme continues

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.

Documentation

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.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

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.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.