You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
yulei d8f76f9e6d
Added missing shutdown_user() hook (#9180)
* add missing shutdown_user()

* use reset_keyboard() from quantum
5 years ago
.github Update cli CI checkout to v2 (#8823) 5 years ago
.vscode Allow trailing whitespace in markdown docs, for formatting purposes. (#8774) 5 years ago
bin Move everything to Python 3.6 (#8835) 5 years ago
docs Fixed the indentation of the sample code in feature_pointing_device docs (#9177) 5 years ago
drivers Fix i2c EEPROM compile issue when Console is enabled (#9186) 5 years ago
keyboards [Keyboard] PDBDOWN should be PCBDOWN. (#9192) 5 years ago
layouts [Keymap] dohmain 60_tsangan_hhkb layout (#9157) 5 years ago
lib CLI: Rework submodule checking (#9162) 5 years ago
quantum Fix build. (#9163) 5 years ago
tests format code according to conventions [skip ci] 5 years ago
tmk_core Added missing shutdown_user() hook (#9180) 5 years ago
users Art userspace (#9068) 5 years ago
util CLI: Improve experience when running `qmk setup` on FreeBSD. (#8798) 5 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Remove old setup scripts (#8811) 5 years ago
.gitmodules Revert "Fix conflicting types for 'tfp_printf' (#8269)" 5 years ago
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Improve the Makefile message a bit more (#9161) 5 years ago
Vagrantfile Remove broken example from Makefile (#9159) 5 years ago
book.json
bootloader.mk
build_full_test.mk
build_json.mk Load keymap-level rules.mk when compiling keymap.json (#8841) 5 years ago
build_keyboard.mk Align some ChibiOS build logic (#8461) 5 years ago
build_layout.mk
build_test.mk Initial arm->chibios pass - simplify some platform logic (#8450) 5 years ago
common.mk
common_features.mk Add SPI 25xx EEPROM support. (#8780) 5 years ago
doxygen-todo Remove Bluefruit protocol (#9008) 5 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 5 years ago
nose2.cfg
readme.md Breaking Changes documentation fixes 5 years ago
requirements-dev.txt Use milc for config check, requirements fixes 5 years ago
requirements.txt CLI: Add development mode support 5 years ago
secrets.tar.enc
setup.cfg
shell.nix Fix up Arm builds with nix-shell. (#8312) 5 years ago
show_options.mk Remove unused LED_BREATHING_TABLE 5 years ago
testlist.mk

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status 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.