Go to file
QMK Bot e83f4e0173 Merge remote-tracking branch 'origin/master' into develop 2021-03-12 21:58:40 +00:00
.github fix CI job: api-data->api_data 2021-03-06 21:26:07 -08:00
.vscode
api_data
bin Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
data Migrate make_dfu_header to CLI (#12061) 2021-02-28 21:25:09 +00:00
docs Merge remote-tracking branch 'origin/master' into develop 2021-03-04 15:20:45 +00:00
drivers Set default OLED Update Interval for Split Keyboards (#12107) 2021-03-05 16:26:57 -08:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-03-12 21:58:40 +00:00
layouts Remove hex_to_keycode and move tap_random_base64 to send_string.c (#12079) 2021-03-12 18:03:44 +11:00
lib Merge remote-tracking branch 'origin/master' into develop 2021-03-09 21:37:12 +00:00
platforms/chibios Add STM32G431 and STM32G474 board definitions. (#11793) 2021-02-06 11:27:46 +11:00
quantum Merge remote-tracking branch 'origin/master' into develop 2021-03-12 07:04:21 +00:00
tests Missed a couple more `#pragma once`s (#11351) 2020-12-30 15:44:53 +00:00
tmk_core Move gpio wait logic to wait.h (#12067) 2021-03-10 22:47:36 +00:00
users [Keymap] arkag Userspace updated (#12183) 2021-03-11 10:01:53 -08:00
util Add support for using podman to util/docker_build.sh (#10819) 2021-02-28 15:59:42 +11:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml CI: Add workflow for codebase formatting (#7382) 2020-12-10 17:01:51 +00:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
Vagrantfile
book.json
bootloader.mk Adds AT90USB162 support (#11570) 2021-01-29 19:53:56 -08:00
build_full_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
build_json.mk Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
build_keyboard.mk Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
build_layout.mk
build_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
common.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common_features.mk LED Matrix: decouple from Backlight (#12054) 2021-03-08 16:55:00 +11:00
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 2021-01-30 13:08:58 -08:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Configure keyboard matrix from info.json (#10817) 2020-12-30 10:27:37 -08:00
nose2.cfg
readme.md Branch point for 2021 May 29 Breaking Change 2021-02-27 12:54:23 -08:00
requirements-dev.txt Audio system overhaul (#11820) 2021-02-15 09:40:38 +11:00
requirements.txt Enforce minimum versions for jsonschema and MILC (#12141) 2021-03-06 15:56:45 -08:00
secrets.tar.enc
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
shell.nix allow customizing decrease delay of rgb heatmap (#11322) 2021-01-14 11:29:00 -08: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

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.

THIS IS THE DEVELOP BRANCH

Warning- This is the develop branch of QMK Firmware. You may encounter broken code here. Please see Breaking Changes for more information.

Original readme continues

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.