Go to file

Joel Challis e0acd3e53d Update requirements.txt (#13135 )		2021-06-08 00:37:58 +01:00
.github	…
.vscode	…
api_data	…
bin	…
data	…
docs	Update Japanese newbs_building_firmware_configurator.md document. (#12836 )	2021-06-08 02:43:21 +09:00
drivers	…
keyboards	[Keyboard] Add program yoink via keymap (#12645 )	2021-06-06 22:10:37 -07:00
layouts	Add default `ortho_1x1` layout (#13118 )	2021-06-07 20:46:22 +10:00
lib	…
nix	…
platforms/chibios	…
quantum	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
tests	…
tmk_core	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
users	…
util	…
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	Update docker util script and travis to use new base container	2019-07-14 21:01:38 -07:00
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	…
disable_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
nose2.cfg	…
readme.md	Revert "Branch point for 2020 Aug 29 Breaking Change"	2020-08-29 14:30:02 -07:00
requirements-dev.txt	Move hid and pyusb to requirements.txt (#13134 )	2021-06-07 16:30:55 -07:00
requirements.txt	Update requirements.txt (#13135 )	2021-06-08 00:37:58 +01:00
secrets.tar.enc	…
setup.cfg	…
shell.nix	[nix] Use niv and poetry2nix to more easily manage dependencies (#11181 )	2021-04-03 08:05:46 -07:00
show_options.mk	add OLED_DRIVER_ENABLE into show_options.mk (#12121 )	2021-03-05 20:26:26 +00:00
testlist.mk	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11: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. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" 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.