Go to file

Pavle Portic c33a49ba0b Add alternating case keyboard mode		3 months ago
.github	Bump actions/stale from 6 to 7 (#19392 )	3 months ago
.vscode	Exclude uf2 files in VS Code (#18186 )	7 months ago
builddefs	Revert to legacy wear-leveling driver by default for F401. (#19328 )	3 months ago
data	Ensure info.json layout macros are somewhat valid (#19236 )	4 months ago
docs	Add docs to cover recent LAYOUT_all lint checks (#19393 )	3 months ago
drivers	Add default limit to OLED dirty processing (#19068 )	4 months ago
keyboards	Add alternating case keyboard mode	3 months ago
layouts	[Keymap] Add Neo2-based keymap for Planck keyboard (#19173 )	3 months ago
lib	WSL `qmk flash firmware.bin` workaround (#19434 )	3 months ago
platforms	Fixup EFL and F4's sector selection. (#19221 )	4 months ago
quantum	Minor alignment of rgb_breathe_table generator (#19403 )	3 months ago
tests	Don't clear keys on layer change unless STRICT_LAYER_RELEASE is enabled (#18577 )	5 months ago
tmk_core	Joystick feature improvements (#19052 )	4 months ago
users	[Keymap] user dvorak_42_key ergodox_ez and crkbd keymaps (#19154 )	4 months ago
util	Fixup installation procedure for different Fedora versions. (#19159 )	4 months ago
.clang-format	Clang-format tweaks (#15906 )	1 year ago
.editorconfig	QMK CLI and JSON keymap support (#6176 )	4 years ago
.gitattributes	eol=lf, where appropriate (#15752 )	1 year ago
.gitignore	Merge remote-tracking branch 'origin/master' into develop	4 months ago
.gitmodules	[Core] Add Raspberry Pi RP2040 support (#14877 )	9 months ago
Dockerfile	move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230 )	2 years ago
Doxyfile	Internal docs generation updates (#16411 )	1 year ago
LICENSE	add an explicit lisence file for github to pickup	5 years ago
Makefile	Remove .noci functionality (#19122 )	4 months ago
Vagrantfile	move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230 )	2 years 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	4 years ago
paths.mk	Remove quantum/audio from global VPATH (#18753 )	5 months ago
readme.md	2022 Nov 26 changelog. (#19164 )	4 months ago
requirements-dev.txt	Macros in JSON keymaps (#14374 )	1 year ago
requirements.txt	Align CLI requirements (#18117 )	7 months ago
setup.cfg	Quantum Painter (#10174 )	12 months ago
shell.nix	Nix shell updates for `develop` (#18131 )	7 months ago

readme.md

Quantum Mechanical Keyboard Firmware

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

See the official documentation on docs.qmk.fm

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.