Go to file
Guilherme Lima aad4319b40 docs: Add Manjaro/Arch dependencies on getting started page (#2701)
* Update getting_started_build_tools.md

* Update getting_started_build_tools.md
2019-01-10 08:28:52 -08:00
.github Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 2018-12-07 16:51:27 -08:00
.vscode
docs docs: Add Manjaro/Arch dependencies on getting started page (#2701) 2019-01-10 08:28:52 -08:00
drivers Adds support for JacoBurge's TouchPad (#4186) 2019-01-10 08:26:40 -08:00
keyboards Adds support for JacoBurge's TouchPad (#4186) 2019-01-10 08:26:40 -08:00
layouts Update bakingpy 4x12 keymap and add test mode for debugging/development (#4810) 2019-01-09 12:23:41 -08:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
tests
tmk_core Add missing parentheses to some important macros (#4775) 2019-01-08 15:08:17 -08:00
users Remove deprecated QUANTUM_DIR code blocks from makefiles (#4754) 2019-01-04 07:25:48 -08:00
util Read user input properly in linux_install.sh for Gentoo (#4395) 2018-12-26 08:01:26 -08:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml Improve diagnostics for build hashes 2018-12-25 17:09:48 -08:00
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 improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
Vagrantfile Update the installation script PR (#4167) 2018-10-22 13:24:43 -07:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json
bootloader.mk
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 Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
doxygen-todo
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
message.mk Treat too-large firmwares as an error, not a warning (#3956) 2018-09-27 13:32:01 -07:00
readme.md
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.