Go to file
Danny a40dbf94e8
Merge pull request #6264 from zvecr/split_master_check
Allow board to override split keyboard master check
2019-07-20 15:13:01 -04: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 QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
docs [Docs] Clarify Zadig usage in FAQ Docs (#6360) 2019-07-19 13:23:16 -07:00
drivers Align ARM i2c_readReg with AVR (#6314) 2019-07-16 01:36:23 -07:00
keyboards Fix Numbrero Handwired make example in readme 2019-07-20 11:06:18 -07:00
layouts Jotix (#6355) 2019-07-18 19:27:09 -07:00
lib Expand bootloader target to support most AVR boards (#6255) 2019-07-16 01:28:23 -07:00
quantum Merge pull request #6264 from zvecr/split_master_check 2019-07-20 15:13:01 -04:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Extend maximum number of backlight levels to 31 (#6351) 2019-07-16 21:58:29 -07:00
users Adding rgb matrix speed into eeprom storage. (#5965) 2019-07-16 00:40:43 -07:00
util Configure Vagrant to use qmk_base_container (#6194) 2019-07-16 01:20:34 -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 Update .gitmodules 2017-11-16 15:09:45 -05:00
.travis.yml Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -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 Make python a required build dependency (#5784) 2019-05-06 10:56:34 -07: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 adds redirects for docs 2017-08-19 08:31:54 -04:00
bootloader.mk Usbasploader bootloader option addition (#6304) 2019-07-15 19:11:59 -07:00
build_full_test.mk Add SRC and OPT_DEFS when building tests 2017-07-20 10:17:31 -04:00
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 Display firmware size percentage (#6307) 2019-07-11 12:05:13 -07:00
readme.md Removes Erez personally from QMK (#5883) 2019-05-15 19:53:45 -04: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.