Go to file

QMK Bot 9c80db1fdc Merge remote-tracking branch 'origin/master' into develop		2021-05-12 23:25:56 +00:00
.github	Merge remote-tracking branch 'origin/master' into develop	2021-05-10 18:19:15 +00:00
.vscode	…
api_data	…
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	Make Swap Hands use PROGMEM (#12284 )	2021-05-09 23:21:09 -07:00
drivers	Merge remote-tracking branch 'origin/master' into develop	2021-05-09 17:15:32 +00:00
keyboards	Merge remote-tracking branch 'origin/master' into develop	2021-05-12 23:25:56 +00:00
layouts	Remove KEYMAP and LAYOUT_kc (#12160 )	2021-05-11 10:10:31 -07:00
lib	Add setup, clone, and env to the list of commands we allow even with broken modules (#12868 )	2021-05-12 09:40:58 -07:00
nix	…
platforms/chibios	Add STM32L433 and L443 support (#12063 )	2021-04-26 13:07:15 +10:00
quantum	Rename `point_t` -> `led_point_t` (#12864 )	2021-05-13 09:17:18 +10:00
tests	…
tmk_core	Fix syntax error when compiling for ARM (#12866 )	2021-05-11 08:17:28 -07:00
users	Remove KEYMAP and LAYOUT_kc (#12160 )	2021-05-11 10:10:31 -07:00
util	New command: qmk console (#12828 )	2021-05-08 20:56:07 -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	…
LICENSE	…
Makefile	…
Vagrantfile	…
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	…
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	…
disable_features.mk	…
doxygen-todo	…
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	…
secrets.tar.enc	…
setup.cfg	…
shell.nix	…
show_options.mk	…
testlist.mk	…

readme.md

Quantum Mechanical Keyboard Firmware

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

See the official documentation on docs.qmk.fm

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.