Go to file
skullY 0ed492978a Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
.github Fix typos in stale.yml (#7489) 2019-11-26 21:45:18 +00:00
.vscode
bin Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
docs Add _summary.md for Russian docs with proper language prefix (#7514) 2019-11-30 13:01:41 +00:00
drivers IS31FL3733 Dirty page fix (#7079) 2019-11-25 20:33:52 +00:00
keyboards [Keymap] Added jhelvy keymaps for keebio/iris and lily58 (#7447) 2019-12-01 12:54:57 -08:00
layouts [Keyboard] Add three missing layouts (#7441) 2019-11-21 20:25:19 -08:00
lib Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
quantum Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484) 2019-11-28 22:00:29 +00:00
tests
tmk_core Remove vusb 'reset to bootloader' hid message due to security implications (#7456) 2019-11-25 20:33:02 +00:00
users [Keymap] Add RGB keycodes to keymap, enable RGB_MATRIX on crkbd (#7499) 2019-11-29 15:48:11 -08:00
util Specify Arm GCC 8 in macOS install script (#7509) 2019-11-29 16:44:18 -08:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md Set up language fallback for docs, and update translation guidelines (#7403) 2019-11-23 16:07:15 +00:00
requirements.txt Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
secrets.tar.enc
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
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 Document" 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.