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
Josef Adamčík 2a43989d30
Apply suggestions from code review
Remove unneeded breaks.

Co-authored-by: Nick Brassel <nick@tzarc.org>
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 Update and try to clarify the CLI installation on Linux (#8783) 5 years ago
drivers Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. (#8775) 5 years ago
keyboards Apply suggestions from code review 5 years ago
layouts [Keymap] Make personal keymaps a bit more consistent (#8915) 5 years ago
lib kle2info: trim down x and y output 5 years ago
quantum format code according to conventions [skip ci] 5 years ago
tests
tmk_core Clean up ATSAM ifdefs (#8808) 5 years ago
users [Keymap] Added Xd75 and viterbi keymaps,refactored my userspace. (#8776) 5 years ago
util Add missing packages to Linux install scripts (#8895) 5 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Remove old setup scripts (#8811) 5 years ago
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
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
common.mk
common_features.mk Add Word Per Minute calculation feature (#8054) 5 years ago
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md
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
show_options.mk
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.