Go to file
QMK Bot 54c368d3aa Merge remote-tracking branch 'origin/master' into develop 2021-05-22 17:19:26 +00:00
.github Merge remote-tracking branch 'origin/master' into develop 2021-05-18 19:26:46 +00:00
.vscode
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
bin Merge remote-tracking branch 'origin/master' into develop 2021-05-10 12:16:04 -07:00
data Add STM32L433 and L443 support (#12063) 2021-04-26 13:07:15 +10:00
docs [Keyboard] Fix Terrazzo build failure (#12977) 2021-05-21 23:56:17 -07:00
drivers Add support for up to 4 IS31FL3733 drivers (#12342) 2021-05-21 21:42:39 -07:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-05-22 17:19:26 +00:00
layouts Convert Encoder callbacks to be boolean functions (#12805) 2021-05-21 23:17:32 -07:00
lib ensure we do not conflict with existing keymap aliases (#12976) 2021-05-21 16:59:10 -07:00
nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
platforms/chibios Merge remote-tracking branch 'origin/master' into develop 2021-05-13 02:30:14 +00:00
quantum Convert Encoder callbacks to be boolean functions (#12805) 2021-05-21 23:17:32 -07:00
tests
tmk_core Fixup housekeeping from being invoked twice per loop. (#12933) 2021-05-18 17:02:28 +10:00
users Convert Encoder callbacks to be boolean functions (#12805) 2021-05-21 23:17:32 -07:00
util Merge remote-tracking branch 'origin/master' into develop 2021-05-19 15:49:11 -07:00
.clang-format
.editorconfig
.gitattributes
.gitignore Merge remote-tracking branch 'origin/master' into develop 2021-04-26 19:18:51 +00:00
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile
Vagrantfile Remove broken example from Makefile (#9159) 2020-05-21 20:33:20 +01:00
book.json
bootloader.mk Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600) 2021-04-25 13:40:56 +10:00
build_full_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
build_json.mk
build_keyboard.mk fix some references to bin/qmk that slipped in (#12832) 2021-05-08 12:25:04 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172) 2021-04-12 21:18:52 +02:00
disable_features.mk
doxygen-todo Remove iWRAP protocol (#9284) 2020-08-29 14:30:02 -07:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk fix some references to bin/qmk that slipped in (#12832) 2021-05-08 12:25:04 -07:00
nose2.cfg
readme.md
requirements-dev.txt New command: qmk console (#12828) 2021-05-08 20:56:07 -07:00
requirements.txt Add support for tab completion (#12411) 2021-04-14 19:00:22 -07:00
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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.

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

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.