Custom keyboard firmware
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.
 
 
 
 
 
Astrid Yu c0ab4ed539
Allow overriding Niv inputs in shell.nix (#16602)
5 days ago
.github Run auto approve only on qmk/qmk_firmware (#16786) 1 month ago
.vscode remove Bracket Pair Colorizer recommendation (#14816) 7 months ago
api_data Generate api data on each push (#10609) 1 year ago
builddefs Ensure .hex file output for ARM Teensys (#17014) 1 week ago
data Lint keyboard/project name (#16766) 1 month ago
docs Add Ukrainian keymap header (#16947) 2 weeks ago
drivers Fix external flash on AVR (#16851) 1 month ago
keyboards [Keyboard] Move M63 RGB into maker folder (#17061) 5 days ago
layouts [Keymap] ergodox: updating osx_whiskey_tango_foxtrot_capslock to use process_record_user (#16715) 1 month ago
lib yapf: disable arithmetic predecence indication (#16749) 1 month ago
platforms [Bug] Fix unused variable error when using ChibiOS Bitbang serial driver (#16709) 1 month ago
quantum Add Ukrainian keymap header (#16947) 2 weeks ago
tests Format code according to conventions (#16322) 3 months ago
tmk_core VUSB - Use correct endpoint poll for VIA (#16691) 1 month ago
users [Keymap] Toinux's crkbd keymap and userspace (#16437) 3 weeks ago
util Add missing dependency for qmk setup on Fedora (#17003) 1 week ago
.clang-format Clang-format tweaks (#15906) 3 months ago
.editorconfig QMK CLI and JSON keymap support (#6176) 2 years ago
.gitattributes eol=lf, where appropriate (#15752) 4 months ago
.gitignore Ignore VIA(L) json files (#16845) 1 month ago
.gitmodules Purge uGFX. (#14720) 7 months ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 8 months ago
Doxyfile Internal docs generation updates (#16411) 2 months ago
LICENSE add an explicit lisence file for github to pickup 4 years ago
Makefile Migrate more makefile utilities to builddefs sub-directory (#16002) 3 months ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 8 months ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 7 months ago
license_GPLv2.md Clarify the quantum license (#1042) 5 years ago
license_GPLv3.md Clarify the quantum license (#1042) 5 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 5 years ago
nose2.cfg Setup a python test framework 2 years ago
paths.mk Migrate more makefile utilities to builddefs sub-directory (#16002) 3 months ago
readme.md [Core] [Docs] Remove travis-ci references (#13916) 8 months ago
requirements-dev.txt Macros in JSON keymaps (#14374) 5 months ago
requirements.txt switch to qmk-dotty-dict (#13460) 10 months ago
setup.cfg yapf: disable arithmetic predecence indication (#16749) 1 month ago
shell.nix Allow overriding Niv inputs in shell.nix (#16602) 5 days 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.