You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Ryan 6ee29d9aa6
Tidy up ADNS9800 and PMW3360 firmware blobs (#14936)
7 hours ago
.github move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 1 month ago
.vscode remove Bracket Pair Colorizer recommendation (#14816) 1 week ago
api_data Generate api data on each push (#10609) 1 year ago
bin Ensure that safe_commands always run (#13199) 4 months ago
data Remove BLUETOOTH_ENABLE from keyboard-level rules.mk (#14379) 1 month ago
docs [Docs] Add default case to tap dance example 5. (#14893) 1 day ago
drivers Tidy up ADNS9800 and PMW3360 firmware blobs (#14936) 7 hours ago
keyboards [Keymap] Add Gergoplex keymap (#14768) 1 day ago
layouts [Keymap] Simplify unicode input mode change and CTRL and GUI swapping (#14874) 1 day ago
lib Try to clarify "number of elements in info.json does not match" error (#14844) 1 week ago
platforms Change USBasp and bootloadHID bootloaders to lowercase (#14354) 1 month ago
quantum Fix type of Tap Dance max index variable (#14887) 4 days ago
tests [Core] Fix "6kro enable" and clarify naming (#14563) 3 weeks ago
tmk_core Check usb transmit status in send_extra() (#14643) 1 day ago
users [Keymap] Add logo to riblee userspace (#14875) 1 day ago
util Cleanup issues identified by lgtm (#14459) 3 weeks ago
.clang-format fix indent size 2 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 2 years ago
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 6 months ago
.gitignore Align some quantum sub-directories (#14134) 2 months ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 1 year ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 1 month ago
Doxyfile Generate API docs from source code comments (#2491) 3 years ago
LICENSE add an explicit lisence file for github to pickup 4 years ago
Makefile Allow community layouts to be specified in info.json (#14682) 2 weeks ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 1 month ago
book.json adds redirects for docs 4 years ago
bootloader.mk Allow AVR Bootloader size to be configurable (#14783) 1 week ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 10 months ago
build_json.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2 months ago
build_keyboard.mk Fix issues with recent keymap.json changes (#14089) 2 months ago
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2 months ago
build_test.mk eeprom_stm32: implement high density wear leveling (#12567) 2 months ago
common.mk Relocate platform specific drivers (#13894) 2 months ago
common_features.mk Bugfix for Joystick and JSON schema (#14295) 1 month ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 8 months ago
doxygen-todo Various fixes from reorg of files (#14051) 2 months ago
license_GPLv2.md Clarify the quantum license (#1042) 4 years ago
license_GPLv3.md Clarify the quantum license (#1042) 4 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 4 years ago
message.mk Move "firmware size check skipped" note to message.mk (#14632) 3 weeks ago
nose2.cfg Setup a python test framework 2 years ago
readme.md [Core] [Docs] Remove travis-ci references (#13916) 2 months ago
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 4 months ago
requirements.txt switch to qmk-dotty-dict (#13460) 3 months ago
setup.cfg Use the schema to eliminate custom code (#11108) 9 months ago
shell.nix Update the nix-shell environment (#13316) 1 month ago
show_options.mk [Core] Fix "6kro enable" and clarify naming (#14563) 3 weeks ago
testlist.mk eeprom_stm32: implement high density wear leveling (#12567) 2 months ago

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.