Go to file
Alex Meyer c2d72a60f0
remove Bracket Pair Colorizer recommendation (#14816)
As of v1.60, vscode has a much faster built-in method of colorizing bracket pairs, making the extension unnecessary.
https://code.visualstudio.com/blogs/2021/09/29/bracket-pair-colorization
2021-10-15 11:54:19 +11:00
.github move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2021-10-15 11:54:19 +11:00
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
bin Ensure that safe_commands always run (#13199) 2021-06-14 16:51:58 -07:00
data Remove BLUETOOTH_ENABLE from keyboard-level rules.mk (#14379) 2021-09-12 15:27:29 +10:00
docs Update Japanese document (#14766) 2021-10-09 21:04:00 +01:00
drivers [Bug] Fix IS31fl3741 driver to accept 1 or 2 addresses (#14451) 2021-09-15 10:07:08 -07:00
keyboards [Keyboard] PLX Refactor (#14809) 2021-10-14 17:00:08 -07:00
layouts [Keymap] Add workman layout (#14792) 2021-10-11 19:26:47 -07:00
lib Allow community layouts to be specified in info.json (#14682) 2021-10-04 09:26:19 -07:00
platforms Change USBasp and bootloadHID bootloaders to lowercase (#14354) 2021-09-10 17:17:54 +10:00
quantum [Bug] Fix command feature if mousekey is enabled and using 3-speed setting (#14697) 2021-10-05 17:50:23 -07:00
tests [Core] Fix "6kro enable" and clarify naming (#14563) 2021-09-29 11:37:11 -07:00
tmk_core Added semicolons to rules.mk to allow symlinks from /bin/sh to /bin/zsh to complete the filesize check without error. (#14718) 2021-10-06 12:58:40 +11:00
users [Keymap] Display default layer name (#14819) 2021-10-14 10:28:06 -07:00
util Cleanup issues identified by lgtm (#14459) 2021-09-27 10:02:54 -07: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 Align some quantum sub-directories (#14134) 2021-08-24 17:07:11 +01:00
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 2020-05-30 13:14:59 -07: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 Allow community layouts to be specified in info.json (#14682) 2021-10-04 09:26:19 -07: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 Allow AVR Bootloader size to be configurable (#14783) 2021-10-11 14:30:17 +01: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 Fix issues with recent keymap.json changes (#14089) 2021-08-20 19:11:49 +10: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 Bugfix for Joystick and JSON schema (#14295) 2021-09-09 10:27:58 +10:00
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 2021-01-30 13:08:58 -08:00
doxygen-todo Various fixes from reorg of files (#14051) 2021-08-18 09:54:41 +10: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 Update the nix-shell environment (#13316) 2021-08-29 22:24:43 +01:00
show_options.mk [Core] Fix "6kro enable" and clarify naming (#14563) 2021-09-29 11:37:11 -07: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.