Open-source keyboard firmware for Atmel AVR and Arm USB families https://qmk.fm
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.
 
 
 
 
 
Yū Kobayashi a550cc7ab0 Update keymaps 6 months ago
.github Merge remote-tracking branch 'origin/master' into develop 7 months ago
.vscode remove Bracket Pair Colorizer recommendation (#14816) 9 months ago
api_data Generate api data on each push (#10609) 2 years ago
builddefs Westberrytech pr (#14422) 7 months ago
data Tidy up NKRO_ENABLE rules (#15382) 7 months ago
docs [Docs] Add drag scrolling example to Pointing device docs page (#15715) 6 months ago
drivers [Bug] Fix analog joystick to mouse compilation (#15677) 6 months ago
keyboards Update keymaps 6 months ago
layouts [Keymap] Reorganization, cleanup and readmes for drashna code (#15617) 6 months ago
lib Format keymaps 6 months ago
platforms Fix RESET not working for keyboards with Kiibohd bootloader (#15430) 7 months ago
quantum fix RGB_DISABLE_TIMEOUT flicker on split keyboards (#14954) 6 months ago
tests [Tests] Increase QMK test coverage take 2 (#15269) 7 months ago
tmk_core Add missing virtser_init() to ChibiOS code (#15356) 7 months ago
users [Keymap] Reorganization, cleanup and readmes for drashna code (#15617) 6 months ago
util Add script for performing compilation size regression investigations. (#15303) 7 months ago
.clang-format fix indent size 3 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 3 years ago
.gitattributes eol=lf, where appropriate (#15752) 6 months ago
.gitignore New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 10 months ago
.gitmodules Purge uGFX. (#14720) 9 months ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 10 months ago
Doxyfile Generate API docs from source code comments (#2491) 4 years ago
LICENSE add an explicit lisence file for github to pickup 5 years ago
Makefile [Tests] Increase QMK test coverage take 2 (#15269) 7 months ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 10 months ago
build_full_test.mk [Tests] Increase QMK test coverage take 2 (#15269) 7 months ago
build_json.mk Add config.h and rules.mk support for data driven keymaps (#12859) 11 months ago
build_keyboard.mk Move tmk_core/common/<plat> (#13918) 7 months ago
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 11 months ago
build_test.mk Re-add encoder tests (#15312) 7 months ago
common_features.mk Move tmk_core/common/<plat> (#13918) 7 months ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 9 months ago
license_GPLv2.md Clarify the quantum license (#1042) 5 years ago
license_GPLv3.md Clarify the quantum license (#1042) 5 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 5 years ago
nose2.cfg Setup a python test framework 3 years ago
paths.mk Move tmk_core/common/<plat> (#13918) 7 months ago
readme.md [Core] [Docs] Remove travis-ci references (#13916) 10 months ago
requirements-dev.txt Macros in JSON keymaps (#14374) 7 months ago
requirements.txt switch to qmk-dotty-dict (#13460) 12 months ago
setup.cfg Use the schema to eliminate custom code (#11108) 1 year ago
shell.nix Remove bin/qmk (#14231) 10 months ago
testlist.mk [Bug] Revert Assymmetrical Split Encoder support (#12090) (#15311) 7 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.