No description
Find a file
chapeau a825b90686
Some checks failed
Update API Data / api_data (push) Has been cancelled
CI Build Major Branch / Determine concurrency (push) Has been cancelled
CI Build Major Branch / Compile keymap default (push) Has been cancelled
CI Build Major Branch / Consolidation (push) Has been cancelled
CLI CI / test (push) Has been cancelled
Update develop after master merge / develop_update (push) Has been cancelled
Lint Format / lint (push) Has been cancelled
Regenerate Files / regen (push) Has been cancelled
Unit Tests / test (push) Has been cancelled
add custom keyboard
2024-12-12 21:52:08 +01:00
.github Bump JamesIves/github-pages-deploy-action from 4.7.1 to 4.7.2 (#24672) 2024-12-03 19:31:16 +00:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Avoid loading keymap rules.mk twice (#24665) 2024-12-02 06:24:44 +11:00
data Allow codegen of keymap.json => keymap.c without requiring layers/layout etc. (#23451) 2024-11-24 20:32:30 +11:00
docs Update hardware_keyboard_guidelines.md to Fix Typos (#24671) 2024-12-03 11:35:39 -07:00
drivers Move pointing device driver code (#24445) 2024-10-25 18:11:51 +01:00
keyboards add custom keyboard 2024-12-12 21:52:08 +01:00
layouts Organise default community layouts summary (#24500) 2024-12-07 09:05:40 +11:00
lib Improve "feature/encoder config both specified" warnings (#24641) 2024-11-30 05:30:45 +00:00
platforms Bring supported STM32F4 configs in line with F4x1 (#24413) 2024-11-21 22:54:01 +11:00
quantum Provide method to save a single default layer in the full range of 0-31 (#24639) 2024-11-25 07:35:21 +11:00
tests Add pointing tests (#24513) 2024-11-23 16:34:32 +00:00
tmk_core Joystick: add support for 8-way hat switch (#24515) 2024-11-09 14:10:10 -08:00
users Remove symbolic linked userspace folder (#22548) 2023-11-27 12:49:44 +11:00
util Simple Python script to show polling rate (#24622) 2024-11-23 14:07:18 +00:00
.clang-format
.clangd clangd enhancements. (#23310) 2024-05-02 20:08:41 +10:00
.editorconfig .editorconfig: fix inline comment, tidy name section for yaml (#24416) 2024-09-21 19:48:31 +01:00
.gitattributes
.gitignore Add via keymaps to gitignore (#24329) 2024-08-26 04:33:40 +01:00
.gitmodules
Doxyfile Remove arm_atsam platform (#24337) 2024-09-02 03:48:17 +01:00
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile Add helper make targets for formatting and pytest. (#23858) 2024-06-04 12:23:25 +10:00
nose2.cfg
paths.mk
readme.md Merge point for 2024q4 breaking change. 2024-11-27 21:26:34 +11:00
requirements-dev.txt
requirements.txt Remove appdirs from requirements.txt (#24550) 2024-10-30 05:43:31 +00:00
setup.cfg
shell.nix Nix shell updates (Nixpkgs 2024-02-23, QMK CLI 1.1.5) (#23143) 2024-02-26 13:04:27 +11:00

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 VitePress. 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.

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.