Go to file
shela 6cc03dd30a
Remove unwanted notes (#13563)
2021-07-16 09:37:49 -07:00
.github enable manual trigger for api data (#13000) 2021-07-09 09:10:45 -07:00
.vscode do not automatically format json (#13320) 2021-06-25 22:47:48 -07:00
api_data
bin
data
docs Remove unwanted notes (#13563) 2021-07-16 09:37:49 -07:00
drivers Optional OLED splash screen and fixed OLED i2c execution time saving (#12294) 2021-06-23 19:52:06 +10:00
keyboards Set some default configurations for GMMK Pro (#13219) 2021-07-16 09:06:23 +10:00
layouts [Keymap] Update Miryoku (#13307) 2021-07-03 09:09:02 -07:00
lib switch to qmk-dotty-dict (#13460) 2021-07-14 09:08:48 -07:00
nix
platforms/chibios
quantum remove `#include "rgblight.h"` when `defined(RGB_MATRIX_ENABLE)` from quantum.h (#13555) 2021-07-16 12:54:56 +09:00
tests
tmk_core Migrate arm_atsam print logic to use common framework (#13554) 2021-07-16 17:08:34 +01:00
users [Keymap] Update Miryoku (#13307) 2021-07-03 09:09:02 -07:00
util /bin/bash to /usr/bin/env bash (#13422) 2021-07-06 07:56:13 -07:00
.clang-format
.editorconfig
.gitattributes
.gitignore Cleanup gitignore (#13390) 2021-07-02 16:08:34 +10:00
.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
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 Update `MSG_PYTHON_MISSING` (#13427) 2021-07-06 15:34:04 +10:00
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt switch to qmk-dotty-dict (#13460) 2021-07-14 09:08:48 -07:00
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk

readme.md

Quantum Mechanical Keyboard Firmware

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