Go to file
Mike Tsao 909d9c228f
Switch default layout to standard TKL; add custom (#12818)
2021-06-24 12:22:07 +10:00
.github 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
.vscode vscode: specify yapf as the formatting provider (#13206) 2021-06-13 17:52:31 -07:00
api_data
bin Ensure that safe_commands always run (#13199) 2021-06-14 16:51:58 -07:00
data Fix issue with crkbd json mapping (#13255) 2021-06-19 20:08:37 -07:00
docs [Docs] pr_checklist: fix capitalization of Vial (#13301) 2021-06-22 17:45:13 -07:00
drivers Optional OLED splash screen and fixed OLED i2c execution time saving (#12294) 2021-06-23 19:52:06 +10:00
keyboards Switch default layout to standard TKL; add custom (#12818) 2021-06-24 12:22:07 +10:00
layouts Add default `ortho_1x1` layout (#13118) 2021-06-07 20:46:22 +10:00
lib Ensure that safe_commands always run (#13199) 2021-06-14 16:51:58 -07:00
nix Update Python dependencies for Nix (#12855) 2021-06-20 14:30:16 +01:00
platforms/chibios Set `BOOTLOADER = stm32-dfu` for all applicable STM32 boards (#12956) 2021-06-08 19:48:46 +10:00
quantum Fix zero condition of reactive runners that will suspend RGB animation (#12710) 2021-06-23 19:45:05 +10:00
tests
tmk_core Make atmel-dfu and chibios-dfu flashing behave more like caterina flashing. (#12552) 2021-06-16 14:20:44 +10:00
users snowe keymap/userspace and Ocean Dream animation (#12477) 2021-06-24 12:21:40 +10:00
util Debian requires package libusb-dev to build bootloaderHID (#13105) 2021-06-15 22:14:53 -07:00
.clang-format
.editorconfig
.gitattributes
.gitignore 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
Vagrantfile
book.json
bootloader.mk Change Lufa-MS size (#13183) 2021-06-15 21:28:17 -07:00
build_full_test.mk
build_json.mk 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
build_keyboard.mk 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk 2021 May 29 Breaking Changes Update (#13034) 2021-05-29 14:38:50 -07:00
disable_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Make atmel-dfu and chibios-dfu flashing behave more like caterina flashing. (#12552) 2021-06-16 14:20:44 +10:00
nose2.cfg
readme.md
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2021-06-07 16:30:55 -07:00
requirements.txt Update requirements.txt (#13135) 2021-06-08 00:37:58 +01:00
secrets.tar.enc
setup.cfg
shell.nix Update Python dependencies for Nix (#12855) 2021-06-20 14:30:16 +01:00
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.