Go to file
Joel Challis 951331cd8d
Fix i2c_readReg16 (#14730)
2021-10-07 11:45:59 +11:00
.github Remove bin/qmk (#14231) 2021-08-29 16:50:22 -07:00
.vscode do not automatically format json (#13320) 2021-06-25 22:47:48 -07:00
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
data Change `MK66F18` -> `MK66FX1M0` (#14659) 2021-09-30 23:14:37 +01:00
docs Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
drivers Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
keyboards Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
layouts Remove sysex API (#14723) 2021-10-06 19:34:46 +11:00
lib Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
platforms Fix i2c_readReg16 (#14730) 2021-10-07 11:45:59 +11:00
quantum Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
tests [Core] Fix "6kro enable" and clarify naming (#14563) 2021-09-29 11:37:11 -07:00
tmk_core Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
users Remove sysex API (#14723) 2021-10-06 19:34:46 +11:00
util Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
.gitignore New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 2021-09-16 14:59:57 +10:00
.gitmodules Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
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 Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
bootloader.mk Change USBasp and bootloadHID bootloaders to lowercase (#14354) 2021-09-10 17:17:54 +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 Add config.h and rules.mk support for data driven keymaps (#12859) 2021-08-18 21:52:41 +01:00
build_keyboard.mk Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2021-08-18 21:52:41 +01:00
build_test.mk eeprom_stm32: implement high density wear leveling (#12567) 2021-08-23 23:15:34 +01:00
common.mk Relocate platform specific drivers (#13894) 2021-08-17 23:43:09 +01:00
common_features.mk Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
disable_features.mk Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
doxygen-todo Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
message.mk Move "firmware size check skipped" note to message.mk (#14632) 2021-09-29 06:08:46 +10:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
readme.md [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2021-06-07 16:30:55 -07:00
requirements.txt switch to qmk-dotty-dict (#13460) 2021-07-14 09:08:48 -07:00
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
shell.nix Remove bin/qmk (#14231) 2021-08-29 16:50:22 -07:00
show_options.mk Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
testlist.mk eeprom_stm32: implement high density wear leveling (#12567) 2021-08-23 23:15:34 +01: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.