Go to file

Ryan 69eca63a84 `qmk doctor`: Don't run udev checks under WSL (#12231 )		2021-03-19 04:24:21 +11:00
.github	fix CI job: api-data->api_data	2021-03-06 21:26:07 -08:00
.vscode	…
api_data	Generate api data on each push (#10609 )	2020-10-25 14:48:44 -07:00
bin	…
data	Migrate make_dfu_header to CLI (#12061 )	2021-02-28 21:25:09 +00:00
docs	Update RGB matrix effects documentation (#12181 )	2021-03-13 11:37:39 +11:00
drivers	…
keyboards	[Keyboard] Add Pachi (#12132 )	2021-03-19 01:25:37 +11:00
layouts	[Keymap] stanrc85 keymap updates (#12184 )	2021-03-16 19:44:13 -07:00
lib	`qmk doctor`: Don't run udev checks under WSL (#12231 )	2021-03-19 04:24:21 +11:00
platforms/chibios	…
quantum	Format code according to conventions (#12244 )	2021-03-15 12:21:14 +11:00
tests	…
tmk_core	[CI] Format code according to conventions (#12277 )	2021-03-18 12:28:50 +11:00
users	[Keymap] Add userspace rverst (#12205 )	2021-03-17 09:44:21 -07:00
util	…
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	`qmk generate-rules-mk`: add `--escape` switch for makefile logic (#12101 )	2021-03-04 15:09:22 +11:00
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	Extract sendstring into its own compilation unit (#12060 )	2021-03-01 07:11:39 +11:00
disable_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	…
requirements-dev.txt	…
requirements.txt	Enforce minimum versions for jsonschema and MILC (#12141 )	2021-03-06 15:56:45 -08:00
secrets.tar.enc	…
setup.cfg	…
shell.nix	…
show_options.mk	add OLED_DRIVER_ENABLE into show_options.mk (#12121 )	2021-03-05 20:26:26 +00:00
testlist.mk	…

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.