Go to file
Tom Barnes 0d3e07a3db
[Docs] Suggest imgur images are edited to set size (#18031)
2022-08-13 17:32:30 -07:00
.github Also disable line ending conversion for merge workflows (#17953) 2022-08-08 19:05:41 +01:00
.vscode
builddefs
data Provide users with replacements for deprecated/invalid functionality where applicable (#17604) 2022-08-06 22:37:40 +10:00
docs [Docs] Suggest imgur images are edited to set size (#18031) 2022-08-13 17:32:30 -07:00
drivers
keyboards [Keyboard] Added Atreyu keyboard. (#17698) 2022-08-13 21:26:05 +01:00
layouts jotix's community ortho_4x12 layout change (#17891) 2022-08-03 11:32:23 +01:00
lib Provide users with replacements for deprecated/invalid functionality where applicable (#17604) 2022-08-06 22:37:40 +10:00
platforms
quantum Remove legacy keycode use from command (#18002) 2022-08-12 03:03:36 +01:00
tests
tmk_core
users Updated gourdo1 GMMK Pro keymaps (#17873) 2022-08-13 17:24:07 +01:00
util Remove old submodules if present (#17930) 2022-08-13 23:23:32 +10:00
.clang-format
.editorconfig
.gitattributes
.gitignore Add .orig to .gitignore (#17626) 2022-07-17 04:38:56 +10:00
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile Remove old submodules if present (#17930) 2022-08-13 23:23:32 +10:00
Vagrantfile
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix Remove Nixpkgs-provided `poetry` from the environment (#17673) 2022-07-18 22:52:55 +03:00

readme.md

Quantum Mechanical Keyboard Firmware

Current Version 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 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.