Go to file
fauxpark 27b3f3141b Fix typo in Open Graph description for docs (#6641) 2019-09-02 07:35:02 -07:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
bin Make the CLI Ψ capital (#6637) 2019-08-30 10:23:36 -07:00
docs Fix typo in Open Graph description for docs (#6641) 2019-09-02 07:35:02 -07:00
drivers Removed prescaler define from avr i2c, as it was impossible to use (#6617) 2019-08-30 17:47:11 -07:00
keyboards [Keyboard] add rgb led configuration for xd87 (#6635) 2019-09-02 07:33:04 -07:00
layouts [Keyboard] Assorted personal keymap/layout updates (#6621) 2019-08-30 17:45:49 -07:00
lib readability enhancements 2019-08-31 08:50:25 -07:00
quantum clang-format changes 2019-08-30 15:01:52 -07:00
tests clang-format changes 2019-08-30 15:01:52 -07:00
tmk_core clang-format changes 2019-08-30 15:01:52 -07:00
users [Keymap] Add leaf60 and tada68 keymaps (#6645) 2019-08-31 11:20:10 -07:00
util Add `dfu-programmer` to `pacman -S` (#6619) 2019-09-02 07:32:14 -07: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 QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitmodules add lufa as a submodule 2019-08-30 15:01:52 -07:00
.travis.yml Always run `util/travis_compiled_push.sh` (#6640) 2019-09-01 09:09:19 -07: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 add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Add an alternative method for keyboard discovery to speed up build (#6073) 2019-08-15 22:03:26 +01:00
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2019-07-16 01:20:34 -07:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json
bootloader.mk Usbasploader bootloader option addition (#6304) 2019-07-15 19:11:59 -07:00
build_full_test.mk
build_json.mk Fix compiling json files. (#6340) 2019-07-15 15:12:35 -07: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 Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07: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 Add a universal flash command for cli (#6224) 2019-08-20 15:39:24 -07:00
readme.md Merge point for 2019 Aug 30 Breaking Change 2019-08-30 15:01:52 -07:00
requirements.txt QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
secrets.tar.enc update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
setup.cfg QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
shell.nix shell.nix: Downgrade gcc-arm-embedded (#5913) 2019-07-16 00:35:15 -07:00
show_options.mk Add option to enable LTO easily (#5674) 2019-05-02 08:03:42 -07: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 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.