Open-source keyboard firmware for Atmel AVR and Arm USB families https://qmk.fm
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
KOBAYASHI Yū 542594ef49 Add existing Cannonball Cursorpad files 2 months ago
.github Bump actions/stale from 5 to 6 (#18456) 3 months ago
.vscode Exclude uf2 files in VS Code (#18186) 3 months ago
builddefs Add eeprom defaults for tinyuf2 bootloader (#18042) 3 months ago
data Clean up data driven mappings syntax (#18257) 3 months ago
docs Remove orphan custom functions reference in keymap docs (#18444) 2 months ago
drivers Add led matrix support for CKLED2001 (#17643) 4 months ago
keyboards Add existing Cannonball Cursorpad files 2 months ago
layouts fix: Remove TERM_ON/TERM_OFF from my keymap (#18354) 3 months ago
lib Add ability to remove temporary files during multibuild. (#18381) 3 months ago
platforms Remove non promicro pins from converters (#18239) 3 months ago
quantum Fix int8_t overflow in RGB heatmap effect (#18410) 3 months ago
tests Remove legacy keycodes from unit tests (#18430) 3 months ago
tmk_core GMMK2: Fix 'ISO' within product name (#18322) 3 months ago
users [Keymap] Tune mod tap configuration for dshields home row mods (#18458) 2 months ago
util Install correct package on Fedora (#18243) 3 months ago
.clang-format Clang-format tweaks (#15906) 10 months ago
.editorconfig QMK CLI and JSON keymap support (#6176) 3 years ago
.gitattributes eol=lf, where appropriate (#15752) 11 months ago
.gitignore Add .orig to .gitignore (#17626) 5 months ago
.gitmodules [Core] Add Raspberry Pi RP2040 support (#14877) 5 months ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 1 year ago
Doxyfile Internal docs generation updates (#16411) 10 months ago
LICENSE add an explicit lisence file for github to pickup 5 years ago
Makefile Merge remote-tracking branch 'origin/master' into develop 4 months ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 1 year ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 1 year ago
license_GPLv2.md Clarify the quantum license (#1042) 6 years ago
license_GPLv3.md Clarify the quantum license (#1042) 6 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 6 years ago
nose2.cfg Setup a python test framework 3 years ago
paths.mk Migrate more makefile utilities to builddefs sub-directory (#16002) 10 months ago
readme.md 2022q3 Changelog. (#18180) 3 months ago
requirements-dev.txt Macros in JSON keymaps (#14374) 1 year ago
requirements.txt Align CLI requirements (#18117) 4 months ago
setup.cfg Quantum Painter (#10174) 8 months ago
shell.nix Nix shell updates for `develop` (#18131) 4 months 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.