Go to file
Ralph Bacolod 3ed4a7086e
Update readme.md (#17489)
Fixed link to http://mkweb.bcgsc.ca/carpalx/?popular_alternatives
2022-07-03 00:10:30 +01:00
.github
.vscode
builddefs
data
docs MSYS2 install: use MinGW python-qmk package (#17302) 2022-07-02 15:08:05 +01:00
drivers
keyboards Update readme.md (#17489) 2022-07-03 00:10:30 +01:00
layouts [Keymap] Update Miryoku (#16482) 2022-07-02 21:26:23 +10:00
lib Allow locate_keymap to handle DEFAULT_FOLDER (#17529) 2022-07-01 22:20:32 +01:00
platforms [Split] Ensure SOFT_SERIAL_PIN is defined if USE_I2C isn't defined (#17466) 2022-06-25 12:34:40 -07:00
quantum Allow for RGB actions to take place on Keydown instead of Keyup (#16886) 2022-07-02 22:49:49 +10:00
tests
tmk_core
users [Userspace] Add Nasu to userspace code (#17524) 2022-07-02 20:10:07 +01:00
util MSYS2 install: use MinGW python-qmk package (#17302) 2022-07-02 15:08:05 +01:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile
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

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.