Go to file
Ryan e3211e307e
Fix small typo in V-USB configuration descriptor (#11253)
2020-12-21 13:12:07 +11:00
.github Yet another stab at trying to get github actions to push (#11230) 2020-12-16 23:00:02 +00:00
.vscode
api_data
bin
docs Updated usage of qmk c2json (#11148) 2020-12-18 21:56:23 +01:00
drivers Various compilation fixes for avr-gcc 10 (#9269) 2020-12-18 17:28:29 +00:00
keyboards [Keymap] fix keyboards/helix/rev2/keymaps/default/oled_display.c (#11228) 2020-12-20 13:27:54 +11:00
layouts Bocaj - Third Annual Refactor (Redux) (#10295) 2020-12-06 17:30:27 +11:00
lib Doctor: add check for .git folder (#11208) 2020-12-20 15:46:01 +01:00
platforms/chibios Normalise include statements in core code (#11153) 2020-12-11 13:45:24 +11:00
quantum Various compilation fixes for avr-gcc 10 (#9269) 2020-12-18 17:28:29 +00:00
tests
tmk_core Fix small typo in V-USB configuration descriptor (#11253) 2020-12-21 13:12:07 +11:00
users Selectively enable command and console for yanfali userspace (#11212) 2020-12-14 11:13:00 -08:00
util Follow symlinks when listing keyboards. (#11250) 2020-12-20 19:08:39 +11:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml CI: Add workflow for codebase formatting (#7382) 2020-12-10 17:01:51 +00:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Add the ability to exclude keyboards from travis builds (#11178) 2020-12-18 12:17:53 -08:00
Vagrantfile
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
build_layout.mk
build_test.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common_features.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md
message.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
secrets.tar.enc
setup.cfg
shell.nix nix-shell: add milc dependency (#11086) 2020-11-30 21:03:03 +00:00
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
testlist.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08: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.

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.