You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
kb-elmo 4720aa4a34
Change Lufa-MS size (#13183)
2 years ago
.github 2021 May 29 Breaking Changes Update (#13034) 2 years ago
.vscode vscode: specify yapf as the formatting provider (#13206) 2 years ago
api_data Generate api data on each push (#10609) 3 years ago
bin Ensure that safe_commands always run (#13199) 2 years ago
data 2021 May 29 Breaking Changes Update (#13034) 2 years ago
docs [Docs] Update one_shot_keys.md (#12291) 2 years ago
drivers Tidy up spi_master includes (#13053) 2 years ago
keyboards Change Lufa-MS size (#13183) 2 years ago
layouts Add default `ortho_1x1` layout (#13118) 2 years ago
lib Ensure that safe_commands always run (#13199) 2 years ago
nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 3 years ago
platforms/chibios Set `BOOTLOADER = stm32-dfu` for all applicable STM32 boards (#12956) 2 years ago
quantum Fix Bug with (RGB|LED)_DISABLE_WHEN_USB_SUSPENDED define (#13060) 2 years ago
tests Missed a couple more `#pragma once`s (#11351) 3 years ago
tmk_core Make atmel-dfu and chibios-dfu flashing behave more like caterina flashing. (#12552) 2 years ago
users Update noroadsleft userspace and keymaps (2021-06-02) (#13086) 2 years ago
util 2021 May 29 Breaking Changes Update (#13034) 2 years ago
.clang-format fix indent size 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 3 years ago
.gitignore 2021 May 29 Breaking Changes Update (#13034) 2 years ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 3 years ago
.travis.yml CI: Add workflow for codebase formatting (#7382) 3 years ago
CODE_OF_CONDUCT.md updates the coc 4 years ago
Dockerfile Update docker util script and travis to use new base container 4 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile 2021 May 29 Breaking Changes Update (#13034) 2 years ago
Vagrantfile Remove broken example from Makefile (#9159) 3 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Change Lufa-MS size (#13183) 2 years ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 3 years ago
build_json.mk 2021 May 29 Breaking Changes Update (#13034) 2 years ago
build_keyboard.mk 2021 May 29 Breaking Changes Update (#13034) 2 years ago
build_layout.mk Allow for building layouts from keymap.json files. 3 years ago
build_test.mk Ensure single newline at EOF for core files (#11310) 3 years ago
common.mk 2020 November 28 Breaking Changes Update (#11053) 3 years ago
common_features.mk 2021 May 29 Breaking Changes Update (#13034) 2 years ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 3 years ago
doxygen-todo Remove iWRAP protocol (#9284) 3 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk Make atmel-dfu and chibios-dfu flashing behave more like caterina flashing. (#12552) 2 years ago
nose2.cfg Setup a python test framework 4 years ago
readme.md Revert "Branch point for 2020 Aug 29 Breaking Change" 3 years ago
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2 years ago
requirements.txt Update requirements.txt (#13135) 2 years ago
secrets.tar.enc update building for .hex, secrets moving 6 years ago
setup.cfg Use the schema to eliminate custom code (#11108) 3 years ago
shell.nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 3 years ago
show_options.mk add OLED_DRIVER_ENABLE into show_options.mk (#12121) 3 years ago
testlist.mk Ensure single newline at EOF for core files (#11310) 3 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.