Go to file
Álvaro A. Volpato f889e26ed7
Documentation typo fix (#15298)
* Fix WS2812 driver docs typo
2021-11-25 20:13:16 +00:00
.github Merge remote-tracking branch 'origin/master' into develop 2021-11-23 01:41:28 +00:00
.vscode
api_data
builddefs New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 2021-11-26 07:06:50 +11:00
data Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
docs Documentation typo fix (#15298) 2021-11-25 20:13:16 +00:00
drivers Tidy up adjustable ws2812 timing (#15299) 2021-11-25 19:35:06 +00:00
keyboards Remove use of __flash due to LTO issues (#15268) 2021-11-24 18:38:49 +11:00
layouts
lib Merge remote-tracking branch 'origin/master' into develop 2021-11-23 00:24:00 +00:00
platforms Tidy up adjustable ws2812 timing (#15299) 2021-11-25 19:35:06 +00:00
quantum New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 2021-11-26 07:06:50 +11:00
tests [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
tmk_core
users
util
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
Vagrantfile
book.json
build_full_test.mk [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt
setup.cfg
shell.nix
testlist.mk [Tests] Increase QMK test coverage take 2 (#15269) 2021-11-23 13:31:01 +11:00

readme.md

Quantum Mechanical Keyboard Firmware

Current Version 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.