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.
 
 
 
 
 
remanifest 4782e038d9
Added semicolons to rules.mk to allow symlinks from /bin/sh to /bin/zsh to complete the filesize check without error. (#14718)
2 years ago
.github move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
.vscode do not automatically format json (#13320) 2 years ago
api_data Generate api data on each push (#10609) 3 years ago
bin Ensure that safe_commands always run (#13199) 2 years ago
data Remove BLUETOOTH_ENABLE from keyboard-level rules.mk (#14379) 2 years ago
docs More PR checklist updates (#14705) 2 years ago
drivers [Bug] Fix IS31fl3741 driver to accept 1 or 2 addresses (#14451) 2 years ago
keyboards [Keyboard] Add basic Keyhive Sofle support (#14296) 2 years ago
layouts [Keymap] Some updates to mechmerlin userspace and keymaps (#14711) 2 years ago
lib Allow community layouts to be specified in info.json (#14682) 2 years ago
platforms Change USBasp and bootloadHID bootloaders to lowercase (#14354) 2 years ago
quantum [Bug] Fix command feature if mousekey is enabled and using 3-speed setting (#14697) 2 years ago
tests [Core] Fix "6kro enable" and clarify naming (#14563) 2 years ago
tmk_core Added semicolons to rules.mk to allow symlinks from /bin/sh to /bin/zsh to complete the filesize check without error. (#14718) 2 years ago
users [Keymap] Some updates to mechmerlin userspace and keymaps (#14711) 2 years ago
util Cleanup issues identified by lgtm (#14459) 2 years ago
.clang-format fix indent size 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 3 years ago
.gitignore Align some quantum sub-directories (#14134) 2 years ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 3 years ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile Allow community layouts to be specified in info.json (#14682) 2 years ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Change USBasp and bootloadHID bootloaders to lowercase (#14354) 2 years ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 3 years ago
build_json.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2 years ago
build_keyboard.mk Fix issues with recent keymap.json changes (#14089) 2 years ago
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2 years ago
build_test.mk eeprom_stm32: implement high density wear leveling (#12567) 2 years ago
common.mk Relocate platform specific drivers (#13894) 2 years ago
common_features.mk Bugfix for Joystick and JSON schema (#14295) 2 years ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 3 years ago
doxygen-todo Various fixes from reorg of files (#14051) 2 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk Move "firmware size check skipped" note to message.mk (#14632) 2 years ago
nose2.cfg Setup a python test framework 4 years ago
readme.md [Core] [Docs] Remove travis-ci references (#13916) 2 years ago
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2 years ago
requirements.txt switch to qmk-dotty-dict (#13460) 2 years ago
setup.cfg Use the schema to eliminate custom code (#11108) 3 years ago
shell.nix Update the nix-shell environment (#13316) 2 years ago
show_options.mk [Core] Fix "6kro enable" and clarify naming (#14563) 2 years ago
testlist.mk eeprom_stm32: implement high density wear leveling (#12567) 2 years 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.