Go to file
Yan-Fa Li d0c29f25c9 [Keyboard] Fix the layer state messages for actual values (#6116)
- display adjust when the bits are set correctly
2019-06-11 02:45:00 -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
docs Fixing OLED Driver for 128x64 displays (#6085) 2019-06-07 17:02:05 -07:00
drivers Fixing OLED Driver for 128x64 displays (#6085) 2019-06-07 17:02:05 -07:00
keyboards [Keyboard] Fix the layer state messages for actual values (#6116) 2019-06-11 02:45:00 -07:00
layouts Add 60_ansi_split_bs_rshift layout to DZ60, with a new keymap for the same (#6096) 2019-06-07 17:01:13 -07:00
lib Spirals, Pinwheels, and Documentation....Oh My! RGB Matrix Effects (#5877) 2019-05-19 09:19:46 -07:00
quantum Remove all Copyrighted Sounds and Songs (#5905) 2019-06-06 12:23:46 -07:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Fixes compile errors for massdrop keyboards 2019-06-03 12:11:03 -07:00
users [Keymap] Set a short TAP_CODE_DELAY so media keys work (#6097) 2019-06-07 12:58:23 -07:00
util Change from avr-gcc@7 to @8 for Mac 2019-06-05 17:51:39 -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 Update our style guide (#5500) 2019-04-18 15:59:51 -07:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Ignore VSCode ipsh folder (#5741) 2019-04-30 09:18:11 -07:00
.gitmodules Update .gitmodules 2017-11-16 15:09:45 -05:00
.travis.yml Use qmk docker image for travis CI builds 2019-05-31 11:04:16 -07:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile upgrade gcc-arm-none-eabi from the default 5.4.1 to 6.3.1 due to ARM runtime issues 2019-06-03 17:14:34 -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 Make python a required build dependency (#5784) 2019-05-06 10:56:34 -07:00
Vagrantfile Update run command now that the install script is unattended, fix mount point for Debian (#5847) 2019-05-11 17:55:12 -07:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
bootloader.mk Add Teensy ++ 2.0 bootloader support 2018-05-08 20:08:17 -04:00
build_full_test.mk Add SRC and OPT_DEFS when building tests 2017-07-20 10:17:31 -04:00
build_keyboard.mk Fix LIB_SRC insert position (#5731) 2019-05-03 06:20:23 -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 Split common.mk into common.mk and common_features.mk 2017-06-18 21:22:22 +03:00
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk rgblight 255 hue (#5547) 2019-05-01 08:02:02 -07:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
message.mk Make python a required build dependency (#5784) 2019-05-06 10:56:34 -07:00
readme.md Removes Erez personally from QMK (#5883) 2019-05-15 19:53:45 -04:00
secrets.tar.enc update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
shell.nix shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -08:00
show_options.mk Add option to enable LTO easily (#5674) 2019-05-02 08:03:42 -07:00
testlist.mk Add basic infrastrucure for building full tests 2017-06-18 21:08:23 +03:00

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.