Go to file
Mateusz Ż 94755308e0
Fix anchors with <code> in table of content (#15169)
2022-05-14 23:08:32 +01:00
.github Run auto approve only on qmk/qmk_firmware (#16786) 2022-04-04 07:01:16 +10:00
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2021-10-15 11:54:19 +11:00
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
builddefs Ensure .hex file output for ARM Teensys (#17014) 2022-05-06 13:18:03 +01:00
data Lint keyboard/project name (#16766) 2022-04-01 10:25:43 +01:00
docs Fix anchors with <code> in table of content (#15169) 2022-05-14 23:08:32 +01:00
drivers [Bug] Updated Cirque Pinnacle SPI driver to read data correctly (#17074) 2022-05-12 23:21:25 -07:00
keyboards Eason Capsule65 Community Layout Support (#17090) 2022-05-14 22:28:29 +01:00
layouts F13 TKL with Split Backspace and Split Right Shift Community Layouts (#17082) 2022-05-14 09:14:19 -07:00
lib yapf: disable arithmetic predecence indication (#16749) 2022-03-30 21:54:13 +01:00
platforms [Bug] Fix unused variable error when using ChibiOS Bitbang serial driver (#16709) 2022-03-23 09:38:51 -07:00
quantum Add Ukrainian keymap header (#16947) 2022-04-28 00:11:41 +01:00
tests Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
tmk_core VUSB - Use correct endpoint poll for VIA (#16691) 2022-03-19 17:40:47 +00:00
users [Keymap] Toinux's crkbd keymap and userspace (#16437) 2022-04-22 17:41:54 +10:00
util Add missing dependency for qmk setup on Fedora (#17003) 2022-05-04 19:55:47 -07: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 eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Ignore VIA(L) json files (#16845) 2022-04-14 15:42:24 +10:00
.gitmodules Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Migrate more makefile utilities to builddefs sub-directory (#16002) 2022-02-10 09:45:51 -08:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
paths.mk Migrate more makefile utilities to builddefs sub-directory (#16002) 2022-02-10 09:45:51 -08:00
readme.md Start `develop` for 2022q1. 2021-11-28 11:16:20 +11:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt switch to qmk-dotty-dict (#13460) 2021-07-14 09:08:48 -07:00
setup.cfg yapf: disable arithmetic predecence indication (#16749) 2022-03-30 21:54:13 +01:00
shell.nix Allow overriding Niv inputs in shell.nix (#16602) 2022-05-12 09:49:15 +03: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.