Takeshi ISHII 09dfc08207 add OLED_DRIVER_ENABLE into show_options.mk (#12121 )		3 years ago
.github	[CI] Format develop (#11893)	3 years ago
.vscode	[Keyboard] add rhymestone by marksard (#9708)	3 years ago
api_data	Generate api data on each push (#10609)	3 years ago
bin	Create a system to map between info.json and config.h/rules.mk (#11548)	3 years ago
data	Migrate make_dfu_header to CLI (#12061)	3 years ago
docs	[Docs] Japanese translation of docs/keycodes.md (#10192)	3 years ago
drivers	Merge branch 'master' into develop	3 years ago
keyboards	[Keyboard] add Boston keyboard (#11273)	3 years ago
layouts	[Keymap] Add 60_ansi_arrow_split_bs_7u_spc layout & keymap (#11329)	3 years ago
lib	`qmk generate-rules-mk`: add `--escape` switch for makefile logic (#12101)	3 years ago
platforms/chibios	Add STM32G431 and STM32G474 board definitions. (#11793)	3 years ago
quantum	Remove ifdefs for Swap Hands keycodes (#12095)	3 years ago
tests	Missed a couple more `#pragma once`s (#11351)	3 years ago
tmk_core	Set default for USB_SUSPEND_WAKEUP_DELAY to 0/disabled (#12081)	3 years ago
users	[Keymap] Initial commit for keyboardio/atreus/dshields keymap. (#11946)	3 years ago
util	Add support for using podman to util/docker_build.sh (#10819)	3 years ago
.clang-format	fix indent size	4 years ago
.editorconfig	QMK CLI and JSON keymap support (#6176)	4 years ago
.gitattributes	Set eep files to binary mode	7 years ago
.gitignore	Generate api data on each push (#10609)	3 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	Configure keyboard matrix from info.json (#10817)	3 years ago
Vagrantfile	Remove broken example from Makefile (#9159)	3 years ago
book.json	adds redirects for docs	6 years ago
bootloader.mk	Adds AT90USB162 support (#11570)	3 years ago
build_full_test.mk	Ensure single newline at EOF for core files (#11310)	3 years ago
build_json.mk	Load keymap-level rules.mk when compiling keymap.json (#8841)	4 years ago
build_keyboard.mk	`qmk generate-rules-mk`: add `--escape` switch for makefile logic (#12101)	3 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	Extract sendstring into its own compilation unit (#12060)	3 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	Configure keyboard matrix from info.json (#10817)	3 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	Audio system overhaul (#11820)	3 years ago
requirements.txt	Create a system to map between info.json and config.h/rules.mk (#11548)	3 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	allow customizing decrease delay of rgb heatmap (#11322)	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

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

See the official documentation on docs.qmk.fm

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.