Go to file

XScorpion2 3c2e69af79 Fixing transport's led/rgb matrix suspend state logic (#12770 )		2021-05-01 12:14:17 -07:00
.github
.vscode	[Keyboard] add rhymestone by marksard (#9708 )	2020-09-04 04:14:34 -07:00
api_data	Generate api data on each push (#10609 )	2020-10-25 14:48:44 -07:00
bin
data
docs
drivers	Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403 )	2021-04-25 11:15:37 +10:00
keyboards	Merge remote-tracking branch 'origin/master' into develop	2021-05-01 01:00:34 +00:00
layouts
lib	Merge remote-tracking branch 'origin/master' into develop	2021-05-01 01:00:34 +00:00
nix	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	2021-04-03 08:05:46 -07:00
platforms/chibios
quantum	Fixing transport's led/rgb matrix suspend state logic (#12770 )	2021-05-01 12:14:17 -07:00
tests
tmk_core
users	Merge remote-tracking branch 'origin/master' into develop	2021-04-27 06:45:17 +00:00
util	Merge remote-tracking branch 'origin/master' into develop	2021-04-29 16:49:03 +00:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
.travis.yml
book.json
bootloader.mk
build_full_test.mk
build_json.mk	Begin the process of deprecating bin/qmk in favor of the global cli (#12109 )	2021-03-07 19:10:03 -08:00
build_keyboard.mk
build_layout.mk
build_test.mk
CODE_OF_CONDUCT.md
common_features.mk	Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172 )	2021-04-12 21:18:52 +02:00
common.mk
disable_features.mk
Dockerfile	Update docker util script and travis to use new base container	2019-07-14 21:01:38 -07:00
Doxyfile	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile
message.mk	Add support for producing UF2-format binaries. (#12435 )	2021-04-06 16:39:15 +10:00
nose2.cfg
readme.md
requirements-dev.txt	Remove `wave` from requirements-dev.txt (#12387 )	2021-04-03 09:15:39 -07:00
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk
Vagrantfile	Remove broken example from Makefile (#9159 )	2020-05-21 20:33:20 +01:00

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.