No Description

James Young b73f8de10b correct Configurator layout data (#13448) 4 years ago
.github 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 years ago
.vscode 848da57d6e do not automatically format json (#13320) 4 years ago
api_data 0c42f91f4c Generate api data on each push (#10609) 4 years ago
bin 0713797c58 Ensure that safe_commands always run (#13199) 4 years ago
data 88e53ad9ca Fix issue with crkbd json mapping (#13255) 4 years ago
docs fdf71f1aa7 [Docs] RGB Matrix Caps Lock and Layer indicator example (#13367) 4 years ago
drivers 6e1ed1c9d3 Optional OLED splash screen and fixed OLED i2c execution time saving (#12294) 4 years ago
keyboards b73f8de10b correct Configurator layout data (#13448) 4 years ago
layouts 65f8da3034 [Keymap] Update Miryoku (#13307) 4 years ago
lib 53ace430fe Doctor: print CLI version (#13356) 4 years ago
nix 7ab4902543 Update Python dependencies for Nix (#12855) 4 years ago
platforms 9dcd03b6ca Set `BOOTLOADER = stm32-dfu` for all applicable STM32 boards (#12956) 4 years ago
quantum dc3896e31c Cleanup junk chars, part 4 (#13345) 4 years ago
tests 7071900407 Missed a couple more `#pragma once`s (#11351) 4 years ago
tmk_core 06e0643541 Add "Ctrl+C to cancel" to "waiting for bootloader" messages (#13424) 4 years ago
users 65f8da3034 [Keymap] Update Miryoku (#13307) 4 years ago
util ba35c11807 Debian requires package libusb-dev to build bootloaderHID (#13105) 4 years ago
.clang-format c3c61dc76e fix indent size 6 years ago
.editorconfig a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 years ago
.gitattributes d91938c19d [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 4 years ago
.gitignore 5046883531 Cleanup gitignore (#13390) 4 years ago
.gitmodules fced377ac0 2020 May 30 Breaking Changes Update (#9215) 5 years ago
.travis.yml 6c4b6531fe CI: Add workflow for codebase formatting (#7382) 4 years ago
CODE_OF_CONDUCT.md e243afe23e updates the coc 5 years ago
Dockerfile d8253b83e8 Update docker util script and travis to use new base container 6 years ago
Doxyfile 7c9d5ace14 Generate API docs from source code comments (#2491) 7 years ago
LICENSE 5cdf47a79e add an explicit lisence file for github to pickup 7 years ago
Makefile 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 years ago
Vagrantfile dae6f6b39b Remove broken example from Makefile (#9159) 5 years ago
book.json d8145c8464 adds redirects for docs 7 years ago
bootloader.mk 4720aa4a34 Change Lufa-MS size (#13183) 4 years ago
build_full_test.mk 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 years ago
build_json.mk 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 years ago
build_keyboard.mk 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 years ago
build_layout.mk 5eb4675fda Allow for building layouts from keymap.json files. 5 years ago
build_test.mk 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 years ago
common.mk c66df16644 2020 November 28 Breaking Changes Update (#11053) 4 years ago
common_features.mk 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 years ago
disable_features.mk d02c4c5241 Add a <FEATURE>_SUPPORTED flag (#9058) 4 years ago
doxygen-todo 5cc3ab38c9 Remove iWRAP protocol (#9284) 4 years ago
license_GPLv2.md 23839b8c6d Clarify the quantum license (#1042) 8 years ago
license_GPLv3.md 23839b8c6d Clarify the quantum license (#1042) 8 years ago
license_Modified_BSD.md 23839b8c6d Clarify the quantum license (#1042) 8 years ago
message.mk 06e0643541 Add "Ctrl+C to cancel" to "waiting for bootloader" messages (#13424) 4 years ago
nose2.cfg 5b7a5b2a76 Setup a python test framework 5 years ago
readme.md d3721bdff9 Revert "Branch point for 2020 Aug 29 Breaking Change" 4 years ago
requirements-dev.txt c277ae4768 Move hid and pyusb to requirements.txt (#13134) 4 years ago
requirements.txt e0acd3e53d Update requirements.txt (#13135) 4 years ago
secrets.tar.enc c3c07eff51 update building for .hex, secrets moving 7 years ago
setup.cfg 962bc8d9dd Use the schema to eliminate custom code (#11108) 4 years ago
shell.nix 7ab4902543 Update Python dependencies for Nix (#12855) 4 years ago
show_options.mk 09dfc08207 add OLED_DRIVER_ENABLE into show_options.mk (#12121) 4 years ago
testlist.mk 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 years ago

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.