No description
Find a file
2021-03-08 16:55:00 +11:00
.github fix CI job: api-data->api_data 2021-03-06 21:26:07 -08:00
.vscode [Keyboard] add rhymestone by marksard (#9708) 2020-09-04 04:14:34 -07:00
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
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-07 23:34:13 +00:00
layouts [Keymap] Add 60_ansi_arrow_split_bs_7u_spc layout & keymap (#11329) 2021-03-05 10:30:06 -08:00
lib Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
platforms/chibios Add STM32G431 and STM32G474 board definitions. (#11793) 2021-02-06 11:27:46 +11:00
quantum LED Matrix: decouple from Backlight (#12054) 2021-03-08 16:55:00 +11:00
tests Missed a couple more #pragma onces (#11351) 2020-12-30 15:44:53 +00:00
tmk_core LED Matrix: decouple from Backlight (#12054) 2021-03-08 16:55:00 +11:00
users [Keymap] Initial commit for keyboardio/atreus/dshields keymap. (#11946) 2021-02-28 17:07:55 +11:00
util Add support for using podman to util/docker_build.sh (#10819) 2021-02-28 15:59:42 +11:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 2020-05-30 13:14:59 -07:00
.travis.yml CI: Add workflow for codebase formatting (#7382) 2020-12-10 17:01:51 +00:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
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 Allow for building layouts from keymap.json files. 2020-07-07 07:27:39 -07:00
build_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
CODE_OF_CONDUCT.md updates the coc 2019-08-24 12:43:39 -04: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
Dockerfile Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
doxygen-todo Remove iWRAP protocol (#9284) 2020-08-29 14:30:02 -07:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
Makefile Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
message.mk Configure keyboard matrix from info.json (#10817) 2020-12-30 10:27:37 -08:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
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 update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
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
Vagrantfile Remove broken example from Makefile (#9159) 2020-05-21 20:33:20 +01:00

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.