No Description

Koichi Katano 28e10eedda Apply suggestions from code review 6 years ago
.github d02301e59d Swap git diff logic to github action when running qmk info (#9978) 6 years ago
.vscode 52ac6c4303 Allow trailing whitespace in markdown docs, for formatting purposes. (#8774) 6 years ago
bin 66d94dc22a Move everything to Python 3.6 (#8835) 6 years ago
docs 80fd81ad6b [Docs] Japanese translation of docs/ref_functions.md (#9878) 6 years ago
drivers 25e93b4b67 format code according to conventions [skip ci] 6 years ago
keyboards 28e10eedda Apply suggestions from code review 6 years ago
layouts e7cc5a35c2 [Keymap] update ortho_4x12 jotix (#10157) 6 years ago
lib 47f8947bf5 Update vusb to match 3rd endpoint. (#9020) 6 years ago
platforms 9ef4526a2f Remove unused CORTEX_VTOR_INIT (#10053) 6 years ago
quantum 69804bb243 Fixed Spanish keymap extra ES_DIAE symbol (#10211) 6 years ago
tests 5e98eaaaff format code according to conventions [skip ci] 6 years ago
tmk_core a3db72df72 format code according to conventions [skip ci] 6 years ago
users 92385b3fb6 Better handle LTO_ENABLE (#9832) 6 years ago
util 385d49cc39 Initial work for consolidation of ChibiOS platform files (#8327) 6 years ago
.clang-format c3c61dc76e fix indent size 7 years ago
.editorconfig a25dd58bc5 QMK CLI and JSON keymap support (#6176) 7 years ago
.gitattributes de58ec9738 Set eep files to binary mode 10 years ago
.gitignore f11437aef3 Allow for user song list (#9281) 6 years ago
.gitmodules fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
.travis.yml a3933bdbe7 Attempt to fix CI for non-master branches. (#9308) 6 years ago
CODE_OF_CONDUCT.md e243afe23e updates the coc 7 years ago
Dockerfile d8253b83e8 Update docker util script and travis to use new base container 7 years ago
Doxyfile 7c9d5ace14 Generate API docs from source code comments (#2491) 8 years ago
LICENSE 5cdf47a79e add an explicit lisence file for github to pickup 8 years ago
Makefile fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
Vagrantfile dae6f6b39b Remove broken example from Makefile (#9159) 6 years ago
book.json d8145c8464 adds redirects for docs 9 years ago
bootloader.mk b89b2030af Kiibohd bootloader, take 2 (#10129) 6 years ago
build_full_test.mk a5b0f4de35 Add SRC and OPT_DEFS when building tests 9 years ago
build_json.mk 46a84ec84a Load keymap-level rules.mk when compiling keymap.json (#8841) 6 years ago
build_keyboard.mk 385d49cc39 Initial work for consolidation of ChibiOS platform files (#8327) 6 years ago
build_layout.mk 5eb4675fda Allow for building layouts from keymap.json files. 6 years ago
build_test.mk d96380e654 Initial arm->chibios pass - simplify some platform logic (#8450) 6 years ago
common.mk 7f0def77a2 Move Split Common VPATH addition (#4716) 7 years ago
common_features.mk bdd8d2679b Allow joysticks to be used without analog pins (#10169) 6 years ago
doxygen-todo 5cc3ab38c9 Remove iWRAP protocol (#9284) 6 years ago
license_GPLv2.md 23839b8c6d Clarify the quantum license (#1042) 9 years ago
license_GPLv3.md 23839b8c6d Clarify the quantum license (#1042) 9 years ago
license_Modified_BSD.md 23839b8c6d Clarify the quantum license (#1042) 9 years ago
message.mk fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
nose2.cfg 5b7a5b2a76 Setup a python test framework 7 years ago
readme.md d3721bdff9 Revert "Branch point for 2020 Aug 29 Breaking Change" 6 years ago
requirements-dev.txt 724f20ed32 Use milc for config check, requirements fixes 6 years ago
requirements.txt c61f016fa4 CLI: Add development mode support 6 years ago
secrets.tar.enc c3c07eff51 update building for .hex, secrets moving 9 years ago
setup.cfg f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 6 years ago
shell.nix 2b55c419ea shell.nix improvements, and fix problems on Darwin (#9551) 6 years ago
show_options.mk 92385b3fb6 Better handle LTO_ENABLE (#9832) 6 years ago
testlist.mk 30f22d450d Add basic infrastrucure for building full tests 9 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.