Go to file
Jack Humbert 8da9d3330e use built-in arm stuff 2019-01-26 11:36:35 -05:00
.github Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 2018-12-07 16:51:27 -08:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs Add C(), A() and G() to match already existing S() (#4673) 2019-01-25 13:12:48 -08:00
drivers Rename i2c_slave functions so it can coexist with i2c_master (#4875) 2019-01-22 08:57:13 -08:00
keyboards use built-in arm stuff 2019-01-26 11:36:35 -05:00
layouts rs: code friendly keymap for preonic, iris and my preonic clone (#4303) 2019-01-25 12:57:10 -08:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum move `#include "rgb.h"` from quantum.h to quantum.c 2019-01-25 13:38:12 -08:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Fix RGBLIGHT_SLEEP function (#4865) 2019-01-25 17:11:49 -08:00
users [Keymap] Add userspace files for vosechu (#4912) 2019-01-26 07:55:42 -08:00
util Read user input properly in linux_install.sh for Gentoo (#4395) 2018-12-26 08:01:26 -08:00
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2017-12-11 21:06:05 -05:00
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.gitattributes
.gitignore Ajp10304 (#2719) 2018-04-15 09:48:19 -07:00
.gitmodules
.travis.yml Improve diagnostics for build hashes 2018-12-25 17:09:48 -08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile Add a better Docker build script + update Dockerfile (#4222) 2018-12-08 09:42:46 -08:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
Vagrantfile Initial fixes for vagrant (#4900) 2019-01-21 10:24:43 -08:00
autocomplete.sh
book.json
bootloader.mk Add Teensy ++ 2.0 bootloader support 2018-05-08 20:08:17 -04:00
build_full_test.mk
build_keyboard.mk Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
build_layout.mk
build_test.mk
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk Simplify split_common Code significantly (#4772) 2019-01-17 10:08:14 -08:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Treat too-large firmwares as an error, not a warning (#3956) 2018-09-27 13:32:01 -07:00
readme.md Add Atreus as an official board. 2018-08-16 12:01:34 -04:00
secrets.tar.enc
shell.nix shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -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.