You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Kyle McCreery 6a5f29208e
[Docs] Update feature_haptic_feedback.md (#11859)
Arduino playground link to wiring diagram no longer works. Changed the link to point to the correct Adafruit hosted diagram pdf.
5 years ago
.github [CI] Auto Formatting - Swap from direct commit to PR (#11229) 5 years ago
.vscode [Keyboard] add rhymestone by marksard (#9708) 5 years ago
api_data Generate api data on each push (#10609) 5 years ago
bin Move everything to Python 3.6 (#8835) 6 years ago
docs [Docs] Update feature_haptic_feedback.md (#11859) 5 years ago
drivers ws2812: Fix number of nops for AVR at 8 MHz (#9559) 5 years ago
keyboards [Keymap] add noroadsleft userspace; add and update keymaps (#11686) 5 years ago
layouts Userspace updates (#11841) 5 years ago
lib Allow flash/compile to accept relative json paths (#11767) 5 years ago
platforms/chibios Ensure single newline at EOF for core files (#11310) 5 years ago
quantum Migrate some tmk_core files to quantum (#11791) 5 years ago
tests Missed a couple more `#pragma once`s (#11351) 5 years ago
tmk_core Migrate some tmk_core files to quantum (#11791) 5 years ago
users [Keymap] add noroadsleft userspace; add and update keymaps (#11686) 5 years ago
util Exclude more keyboards from CI (#11436) 5 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Generate api data on each push (#10609) 5 years ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 6 years ago
.travis.yml CI: Add workflow for codebase formatting (#7382) 5 years ago
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile remove some old and unused code from Makefile (#11336) 5 years ago
Vagrantfile Remove broken example from Makefile (#9159) 6 years ago
book.json
bootloader.mk Add stm32-dfu and apm32-dfu to bootloader.mk (#11019) 5 years ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 5 years ago
build_json.mk Load keymap-level rules.mk when compiling keymap.json (#8841) 6 years ago
build_keyboard.mk Add a <FEATURE>_SUPPORTED flag (#9058) 5 years ago
build_layout.mk Allow for building layouts from keymap.json files. 6 years ago
build_test.mk Ensure single newline at EOF for core files (#11310) 5 years ago
common.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
common_features.mk Migrate some tmk_core files to quantum (#11791) 5 years ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 5 years ago
doxygen-todo Remove iWRAP protocol (#9284) 5 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
nose2.cfg
readme.md Revert "Branch point for 2020 Aug 29 Breaking Change" 5 years ago
requirements-dev.txt
requirements.txt 2020 November 28 Breaking Changes Update (#11053) 5 years ago
secrets.tar.enc
setup.cfg Ensure single newline at EOF for core files (#11310) 5 years ago
shell.nix allow customizing decrease delay of rgb heatmap (#11322) 5 years ago
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
testlist.mk Ensure single newline at EOF for core files (#11310) 5 years ago

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status 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.