Go to file
QMK Bot e3d59a72f9 format code according to conventions [skip ci] 2020-01-20 18:48:28 +00:00
.github Fix typos in stale.yml (#7489) 2019-11-26 21:45:18 +00:00
.vscode Generalize Tap Dance Layer functions (#6629) 2019-09-21 11:22:27 -07:00
bin Add pep8-naming to our python linting 2019-12-01 13:40:14 -08:00
docs [Docs] Misc cleanups for OLED documentation (#7864) 2020-01-19 14:05:54 -08:00
drivers Run clang-format manually to fix recently changed files (#7934) 2020-01-19 16:30:34 +00:00
keyboards Add VIA support for QMK backlight, QMK RGBLight (#7911) 2020-01-20 10:18:25 -08:00
layouts Merlin's LAYOUT_65_ansi keymap (#7879) 2020-01-14 08:28:35 +11:00
lib Fix attribute heritance for long commands. 2020-01-19 21:29:36 -08:00
quantum format code according to conventions [skip ci] 2020-01-20 18:48:28 +00:00
tests clang-format changes 2019-08-30 15:01:52 -07:00
tmk_core Remove tmk_core gitignore and gitmodules 2020-01-19 10:52:29 -08:00
users [Keymap] Added mverteuil keymaps and userspace common code (#7876) 2020-01-18 11:24:56 -08:00
util Fix unknown key 'IndentPPDirectives' on CI (#7933) 2020-01-19 13:59:57 -08:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2017-12-11 21:06:05 -05:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 2019-10-25 11:48:59 -07:00
.gitmodules add lufa as a submodule 2019-08-30 15:01:52 -07:00
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 2020-01-19 13:59:57 -08:00
CODE_OF_CONDUCT.md updates the coc 2019-08-24 12:43:39 -04:00
Dockerfile Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile Allow 'make all:<user>' to not build EVERYTHING (#7402) 2019-11-20 22:32:16 +00:00
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2019-07-16 01:20:34 -07:00
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 add 'objs-size' target into tmk_core/avr.mk (#5490) 2019-07-15 22:45:31 -07:00
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
build_test.mk
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk switching to you know whats up mode (#7921) 2020-01-17 16:15:58 -05:00
doxygen-todo Remove mbed files (#7605) 2019-12-11 11:36:00 -08:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Add list-keymaps make target (#5563) 2019-09-21 00:00:58 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
readme.md Improve docs "Edit Document" footer 2019-12-18 14:01:13 +11: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 Fix shell.nix by pinning nixpkgs (#6213) 2019-11-14 12:00:36 -08:00
show_options.mk Remove `KEYMAP_SECTION_ENABLE` (#7882) 2020-01-17 00:32:09 +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.