Go to file
jack b756c53c7b
[Docs] Touch up documentation templates & porting keyboard docs (#19573)
2023-01-13 02:58:38 -08:00
.github Bump anothrNick/github-tag-action from 1.58.0 to 1.61.0 (#19519) 2023-01-06 21:45:23 +00:00
.vscode Exclude uf2 files in VS Code (#18186) 2022-08-28 09:59:07 -07:00
builddefs Allow for specifying the number of symbols to output. (#19497) 2023-01-04 16:07:13 +11:00
data Remove invalid pin_compatible config from defaults (#19512) 2023-01-07 17:07:19 +00:00
docs [Docs] Touch up documentation templates & porting keyboard docs (#19573) 2023-01-13 02:58:38 -08:00
drivers Add default limit to OLED dirty processing (#19068) 2022-11-14 01:49:58 +00:00
keyboards Synth Labs 060 Layout Additions and Fixes (#19575) 2023-01-13 02:57:35 -08:00
layouts [Keymap] Add Neo2-based keymap for Planck keyboard (#19173) 2023-01-01 09:31:25 -08:00
lib Fix MATRIX_COLS and MATRIX_ROWS generation for custom matrix (#19508) 2023-01-05 23:40:53 +00:00
platforms Fixup EFL and F4's sector selection. (#19221) 2022-12-02 21:55:28 +11:00
quantum [Bug] Use correct functions for RGB Matrix support in VIA (#19554) 2023-01-10 03:21:38 +00:00
tests Don't clear keys on layer change unless STRICT_LAYER_RELEASE is enabled (#18577) 2022-11-12 02:11:50 +00:00
tmk_core Joystick feature improvements (#19052) 2022-11-27 03:14:45 +11:00
users [Keymap] user dvorak_42_key ergodox_ez and crkbd keymaps (#19154) 2022-12-11 21:21:23 -08:00
util New ChibiOS SVN URL, added new release. (#19493) 2023-01-10 07:19:20 +11:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes
.gitignore Merge remote-tracking branch 'origin/master' into develop 2022-11-22 02:48:11 +00:00
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
nose2.cfg
paths.mk
readme.md 2022 Nov 26 changelog. (#19164) 2022-11-28 07:33:55 +11:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt
setup.cfg
shell.nix Nix shell updates for `develop` (#18131) 2022-08-23 02:59:33 +01:00

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.