You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Drashna Jaelre d05b3da83e
[Bug] Fix unterminated ifdef in ISSI 3733 driver (#15014)
4 years ago
.github
.vscode remove Bracket Pair Colorizer recommendation (#14816) 4 years ago
api_data
builddefs More platform/protocol alignment (#14976) 4 years ago
data [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 years ago
docs Add Pixel Rain RGB Matrix effect (#14155) 4 years ago
drivers [Bug] Fix unterminated ifdef in ISSI 3733 driver (#15014) 4 years ago
keyboards [Keyboard] Fix missing return for oled task on Arabica37 (#15011) 4 years ago
layouts Remove complex `fn_actions` macros (#14662) 4 years ago
lib Merge remote-tracking branch 'origin/master' into develop 4 years ago
platforms Manually format develop (#15003) 4 years ago
quantum Add Pixel Rain RGB Matrix effect (#14155) 4 years ago
tests [Core] Fix "6kro enable" and clarify naming (#14563) 4 years ago
tmk_core Add support to persist MD LED framework settings (#14980) 4 years ago
users [Keymap] Fix missing return for oled task in drashna userspace (#15012) 4 years ago
util [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 4 years ago
.gitmodules Purge uGFX. (#14720) 4 years ago
Dockerfile
Doxyfile
LICENSE
Makefile Migrate makefile utilities to sub-directory (#14917) 4 years ago
Vagrantfile
book.json
build_full_test.mk
build_json.mk
build_keyboard.mk Migrate makefile utilities to sub-directory (#14917) 4 years ago
build_layout.mk
build_test.mk Fix develop after recent changes (#14975) 4 years ago
common_features.mk Add a new led driver for Keychron's keyboards. (#14872) 4 years ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 4 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk Migrate makefile utilities to sub-directory (#14917) 4 years ago
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix
testlist.mk Remove SERIAL_LINK feature (#14727) 4 years ago

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.