No Description

Ryan 6a292e11d3 `qmk fileformat`: only print complaints, and fix some of them (#11278) 5 years ago
.github c807695035 Yet another stab at trying to get github actions to push (#11230) 5 years ago
.vscode 6e32dd123f [Keyboard] add rhymestone by marksard (#9708) 6 years ago
api_data 0c42f91f4c Generate api data on each push (#10609) 5 years ago
bin 66d94dc22a Move everything to Python 3.6 (#8835) 6 years ago
docs 9136c122f8 docs: add Gentoo to newbs_getting_started.md (#11241) 5 years ago
drivers a9f7d4dccc Various compilation fixes for avr-gcc 10 (#9269) 5 years ago
keyboards 6a292e11d3 `qmk fileformat`: only print complaints, and fix some of them (#11278) 5 years ago
layouts 3076f86dc1 Bocaj - Third Annual Refactor (Redux) (#10295) 5 years ago
lib 6a292e11d3 `qmk fileformat`: only print complaints, and fix some of them (#11278) 5 years ago
platforms 501f2fdef1 Normalise include statements in core code (#11153) 5 years ago
quantum 806aa9bc67 Remove comments about custom ldscript for Teensy LC (#11224) 5 years ago
tests 5e98eaaaff format code according to conventions [skip ci] 6 years ago
tmk_core fd177582ad chibios: honor PLATFORMASM in chibios build (#11219) 5 years ago
users e6217b6aa6 Selectively enable command and console for yanfali userspace (#11212) 5 years ago
util 13bbeefc5a Follow symlinks when listing keyboards. (#11250) 5 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 0c42f91f4c Generate api data on each push (#10609) 5 years ago
.gitmodules fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
.travis.yml 6c4b6531fe CI: Add workflow for codebase formatting (#7382) 5 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 03cbee8637 Add the ability to exclude keyboards from travis builds (#11178) 5 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 b0dbe7365b Fix STM32duino bootloader (#10648) 5 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
build_layout.mk 5eb4675fda Allow for building layouts from keymap.json files. 6 years ago
build_test.mk c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
common.mk c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
common_features.mk c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 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 cc08e3082e nix-shell: add milc dependency (#11086) 5 years ago
show_options.mk c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
testlist.mk c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 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.