Go to file
Joel Challis c775104b9f
Use nano specs (#8270)
2020-03-01 11:49:16 +11:00
.github CI: Add workflow for CLI testing (#7357) 2020-02-08 13:43:55 +01:00
.vscode 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
bin Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
docs Breaking Changes documentation fixes 2020-02-29 12:30:38 -08:00
drivers 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
keyboards 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
layouts 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
lib 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
quantum 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
tests clang-format changes 2019-08-30 15:01:52 -07:00
tmk_core Use nano specs (#8270) 2020-03-01 11:49:16 +11:00
users [Keymap] ninjonas keymap updates (#8170) 2020-02-17 01:30:03 -08:00
util 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
.gitmodules 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 2020-01-19 13:59:57 -08:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
Vagrantfile
autocomplete.sh
book.json
bootloader.mk Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2019-12-29 20:53:23 +00:00
build_full_test.mk
build_json.mk Add JSON keymap to prereq list of C keymap 2019-12-08 15:13:47 -08:00
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk 2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
doxygen-todo Remove PJRC USB stack 2020-02-08 11:07:43 -08:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 2020-02-10 04:19:08 +11:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
readme.md Breaking Changes documentation fixes 2020-02-29 12:30:38 -08:00
requirements.txt Drop bs4 dependency, update docs, minor improvements 2020-02-15 15:19:03 -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 Fix shell.nix by pinning nixpkgs (#6213) 2019-11-14 12:00:36 -08:00
show_options.mk Fix AVR boards which were overriding backlight without setting… (#8044) 2020-01-31 10:44:40 +11:00
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.