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.
 
 
 
 
 
Yarmo Mackenbach b7ddad7bf6
Update
4 weeks ago
.github 2021 May 29 Breaking Changes Update (#13034) 2 months ago
.vscode [Keyboard] add rhymestone by marksard (#9708) 11 months ago
api_data Generate api data on each push (#10609) 9 months ago
bin 2021 May 29 Breaking Changes Update (#13034) 2 months ago
data 2021 May 29 Breaking Changes Update (#13034) 2 months ago
docs Update Japanese newbs_building_firmware_configurator.md document. (#12836) 2 months ago
drivers Tidy up spi_master includes (#13053) 2 months ago
keyboards Update 4 weeks ago
layouts Add default `ortho_1x1` layout (#13118) 2 months ago
lib Allow limiting the multibuild based on keymap name. (#13066) 2 months ago
nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 4 months ago
platforms/chibios Set `BOOTLOADER = stm32-dfu` for all applicable STM32 boards (#12956) 2 months ago
quantum Fix Bug with (RGB|LED)_DISABLE_WHEN_USB_SUSPENDED define (#13060) 2 months ago
tests Missed a couple more `#pragma once`s (#11351) 7 months ago
tmk_core 2021 May 29 Breaking Changes Update (#13034) 2 months ago
users Update noroadsleft userspace and keymaps (2021-06-02) (#13086) 2 months ago
util 2021 May 29 Breaking Changes Update (#13034) 2 months ago
.clang-format fix indent size 2 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 2 years ago
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 4 months ago
.gitignore 2021 May 29 Breaking Changes Update (#13034) 2 months ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 1 year ago
.travis.yml CI: Add workflow for codebase formatting (#7382) 8 months ago
CODE_OF_CONDUCT.md updates the coc 2 years ago
Dockerfile Update docker util script and travis to use new base container 2 years ago
Doxyfile Generate API docs from source code comments (#2491) 3 years ago
LICENSE add an explicit lisence file for github to pickup 4 years ago
Makefile 2021 May 29 Breaking Changes Update (#13034) 2 months ago
Vagrantfile Remove broken example from Makefile (#9159) 1 year ago
book.json adds redirects for docs 4 years ago
bootloader.mk Slightly more prominent LUFA Mass-storage bootloader warning. (#13163) 1 month ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 7 months ago
build_json.mk 2021 May 29 Breaking Changes Update (#13034) 2 months ago
build_keyboard.mk 2021 May 29 Breaking Changes Update (#13034) 2 months ago
build_layout.mk Allow for building layouts from keymap.json files. 1 year ago
build_test.mk Ensure single newline at EOF for core files (#11310) 7 months ago
common.mk 2020 November 28 Breaking Changes Update (#11053) 8 months ago
common_features.mk 2021 May 29 Breaking Changes Update (#13034) 2 months ago
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 6 months ago
doxygen-todo Remove iWRAP protocol (#9284) 11 months ago
license_GPLv2.md Clarify the quantum license (#1042) 4 years ago
license_GPLv3.md Clarify the quantum license (#1042) 4 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 4 years ago
message.mk 2021 May 29 Breaking Changes Update (#13034) 2 months ago
nose2.cfg Setup a python test framework 2 years ago
readme.md 2021 February 27 Breaking Changes Changelog (#11975) 5 months ago
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2 months ago
requirements.txt Update requirements.txt (#13135) 2 months ago
secrets.tar.enc update building for .hex, secrets moving 4 years ago
setup.cfg Use the schema to eliminate custom code (#11108) 7 months ago
shell.nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 4 months ago
show_options.mk add OLED_DRIVER_ENABLE into show_options.mk (#12121) 5 months ago
testlist.mk Ensure single newline at EOF for core files (#11310) 7 months 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.