Go to file
Michal Petrik d3584be431
[Docs] Update newbs_building_firmware.md (#16333)
2022-02-21 09:08:07 -08:00
.github
.vscode
api_data
builddefs
data
docs [Docs] Update newbs_building_firmware.md (#16333) 2022-02-21 09:08:07 -08:00
drivers
keyboards Helix/pico move to split_common (#16418) 2022-02-21 08:30:49 -08:00
layouts Add 65_iso_split_bs default layout (#16283) 2022-02-11 11:19:18 +11:00
lib Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
platforms
quantum Fix a potential bug in encoder_init(). (#16372) 2022-02-21 23:13:06 +09:00
tests
tmk_core
users [Keymap] Add uqs' keymaps for various boards and ploopy mouse (#16265) 2022-02-11 19:22:47 -08:00
util
.clang-format
.editorconfig
.gitattributes
.gitignore Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
.gitmodules
Dockerfile
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
Vagrantfile
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix
testlist.mk

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.