Go to file
fauxpark 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 2019-03-24 17:11:26 -07:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode
docs Document an annoyance with Grave Escape and macOS Terminal (#5483) 2019-03-24 17:11:26 -07:00
drivers Fix return value of i2c_readReg and i2c_receive (#5410) 2019-03-15 08:55:07 -07:00
keyboards Bugfix for recently integrated cypher keyboard (#5481) 2019-03-24 14:00:48 -07:00
layouts Add support for RGB LEDs wired directly to each half's controller (#5392) 2019-03-23 17:20:14 -07:00
lib
quantum Add support for RGB LEDs wired directly to each half's controller (#5392) 2019-03-23 17:20:14 -07:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core correct typo in eeprom split target for dfu (#5445) 2019-03-18 23:25:34 -07:00
users [Keymap] New tap dance code added to userspace and keymaps (#5468) 2019-03-22 20:50:56 -07:00
util ISP Flashing Guide - atmega32a info (#4993) 2019-03-22 18:26:21 -07:00
.clang-format Add .clang-format file 2019-02-17 08:59:19 -08:00
.clang_complete
.editorconfig
.gitattributes
.gitignore Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094) 2019-02-13 08:03:26 -08:00
.gitmodules
.travis.yml Remove AUTOGEN and fix Travis Compiled Push scripts (#5077) 2019-02-12 16:46:04 -08:00
CODE_OF_CONDUCT.md
Dockerfile Align docker and vagrant base images (#4905) 2019-03-17 10:36:59 -07:00
Doxyfile
LICENSE
Makefile Shallow clone submodules. (#5279) 2019-03-08 07:58:40 -08:00
Vagrantfile Align docker and vagrant base images (#4905) 2019-03-17 10:36:59 -07:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08: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
common_features.mk Next set of split_common changes (#4974) 2019-03-12 10:23:28 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
readme.md
secrets.tar.enc
shell.nix
show_options.mk Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08: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 hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

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 Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.