Go to file
Drashna Jaelre 6395853148 Docs: Add additional clarification to Leader Key documention (#4660)
* Add clarification for Leader Timeout

* Add additional documentatin to config_options.md

* Add leader_start() and leader_end() documentation

* Add Examples

* Clarify timout

* Remove customization

* Improve docs based on feedback

* Better clarification of features

* Fix example

* Spelling/grammar issue

* Spelling and clarification
2018-12-20 08:58:12 -08:00
.github
.vscode
docs Docs: Add additional clarification to Leader Key documention (#4660) 2018-12-20 08:58:12 -08:00
drivers Also fix use of weak stm32 internal pullup 2018-12-19 11:52:05 -08:00
keyboards Enable RGB animations in Atom47 2018-12-20 08:55:32 -08:00
layouts Dactyl_manuform map and updates to my ergodox layout for moving to a 2018-12-13 10:24:20 -08:00
lib
quantum Overhaul Unicode Common functionality (#4325) 2018-12-19 08:39:24 -08:00
tests
tmk_core Refactor quantum/split_common/i2c.c, quantum/split_common/serial.c (#4522) 2018-12-14 21:31:56 -08:00
users Dactyl_manuform map and updates to my ergodox layout for moving to a 2018-12-13 10:24:20 -08:00
util adjust install_avr function to use unzip for broader compatibility (#4596) 2018-12-10 16:15:15 -08:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile Add a better Docker build script + update Dockerfile (#4222) 2018-12-08 09:42:46 -08:00
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Refactor quantum/split_common/i2c.c, quantum/split_common/serial.c (#4522) 2018-12-14 21:31:56 -08:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Refactor quantum/split_common/i2c.c, quantum/split_common/serial.c (#4522) 2018-12-14 21:31:56 -08:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
readme.md
secrets.tar.enc
shell.nix
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.