Go to file

Joel Challis d2115f7d1c Allow 'make all:<user>' to not build EVERYTHING (#7402 )		2019-11-20 22:32:16 +00:00
.github	Add auto-handling of stale PRs/Issues (#7197 )	2019-11-20 12:17:52 -08:00
.vscode	…
bin	…
docs	[Docs] Start of German translation of documentation (#6909 )	2019-11-20 12:02:56 -08:00
drivers	…
keyboards	Remove keymap_config extern from default keymaps (#7399 )	2019-11-20 22:31:36 +00:00
layouts	[Keymap] All about (ARM) RGB and OLEDs (drashna keymaps) (#7354 )	2019-11-20 12:37:24 -08:00
lib	…
quantum	…
tests	…
tmk_core	…
users	[Keymap] All about (ARM) RGB and OLEDs (drashna keymaps) (#7354 )	2019-11-20 12:37:24 -08:00
util	…
.clang-format	fix indent size	2019-06-11 01:51:40 -07:00
.clang_complete	…
.editorconfig	QMK CLI and JSON keymap support (#6176 )	2019-07-15 12:14:27 -07:00
.gitattributes	…
.gitignore	[Docs] Update hand wire guide (#7044 )	2019-10-25 11:48:59 -07:00
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	updates the coc	2019-08-24 12:43:39 -04:00
Dockerfile	…
Doxyfile	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
LICENSE	…
Makefile	Allow 'make all:<user>' to not build EVERYTHING (#7402 )	2019-11-20 22:32:16 +00:00
Vagrantfile	Configure Vagrant to use qmk_base_container (#6194 )	2019-07-16 01:20:34 -07:00
autocomplete.sh	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	…
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	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	Clarify the quantum license (#1042 )	2017-03-28 15:20:36 -07:00
message.mk	Add list-keymaps make target (#5563 )	2019-09-21 00:00:58 -07:00
nose2.cfg	…
readme.md	…
requirements.txt	…
secrets.tar.enc	…
setup.cfg	…
shell.nix	Fix shell.nix by pinning nixpkgs (#6213 )	2019-11-14 12:00:36 -08:00
show_options.mk	…
testlist.mk	Add basic infrastrucure for building full tests	2017-06-18 21:08:23 +03:00

readme.md

Quantum Mechanical Keyboard Firmware

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

See the official documentation on docs.qmk.fm

The docs are powered by Docsify and hosted on GitHub. You can request changes by making a fork and pull request, or by clicking the "Edit Document" link at the bottom of any page.

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.