No Description

noroadsleft 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 years ago
.github 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 6 years ago
.vscode 05be1de1aa Xton's first keymap! (#2941) 7 years ago
docs 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) 6 years ago
drivers d28684da90 Adds support for JacoBurge's TouchPad (#4186) 6 years ago
keyboards 0ebec1e411 handwired/ortho5x13: layout macro refactor 6 years ago
layouts 67adc29aa3 Remove empty fn_actions[] 6 years ago
lib 6c086f2b6d Revert changes to chibiOS-contrib (#4176) 6 years ago
quantum cd819a7f7e Allows Terminal to use ModTap/LayerTap keys (#4586) 6 years ago
tests 3ea7c2a434 Remove empty action_function() 6 years ago
tmk_core 94ba2e5a9f Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation (#4853) 6 years ago
users 9105bf2434 Add personal userspace, update keymaps (#4845) 6 years ago
util 0c1256e60a Read user input properly in linux_install.sh for Gentoo (#4395) 6 years ago
.clang_complete 98ac32b417 Vim Layout for Ergodox-EZ (mac only) (#2112) 7 years ago
.editorconfig e7bb975482 Fix .editorconfig to not mess with line endings 7 years ago
.gitattributes de58ec9738 Set eep files to binary mode 8 years ago
.gitignore ed62c6e146 Ajp10304 (#2719) 7 years ago
.gitmodules 41f3f01167 Update .gitmodules 7 years ago
.travis.yml ee1be3e5b5 Improve diagnostics for build hashes 6 years ago
CODE_OF_CONDUCT.md ea7bb624de Update CODE_OF_CONDUCT.md 6 years ago
Dockerfile 13ad650136 Add a better Docker build script + update Dockerfile (#4222) 6 years ago
Doxyfile 7c9d5ace14 Generate API docs from source code comments (#2491) 7 years ago
LICENSE 5cdf47a79e add an explicit lisence file for github to pickup 7 years ago
Makefile 2e0c63e0af improve looks like hang up when first time execute make git-submodule (#3846) 6 years ago
Vagrantfile 552b1cccec Update the installation script PR (#4167) 6 years ago
autocomplete.sh 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 years ago
book.json d8145c8464 adds redirects for docs 7 years ago
bootloader.mk 6bd2b8ded3 Add Teensy ++ 2.0 bootloader support 7 years ago
build_full_test.mk a5b0f4de35 Add SRC and OPT_DEFS when building tests 8 years ago
build_keyboard.mk 3cf179be61 Adds Proton C Conversion (#4661) 6 years ago
build_layout.mk d2ff66a985 Creates a layouts/ folder for keymaps shared between keyboards (#1609) 7 years ago
build_test.mk 1c0fe956ac Split common.mk into common.mk and common_features.mk 8 years ago
common.mk 7f0def77a2 Move Split Common VPATH addition (#4716) 6 years ago
common_features.mk 28929ad017 Simplify split_common Code significantly (#4772) 6 years ago
doxygen-todo 7c9d5ace14 Generate API docs from source code comments (#2491) 7 years ago
license_GPLv2.md 23839b8c6d Clarify the quantum license (#1042) 8 years ago
license_GPLv3.md 23839b8c6d Clarify the quantum license (#1042) 8 years ago
license_Modified_BSD.md 23839b8c6d Clarify the quantum license (#1042) 8 years ago
message.mk 8ef747accf Treat too-large firmwares as an error, not a warning (#3956) 6 years ago
readme.md 15a73f4f64 Add Atreus as an official board. 6 years ago
secrets.tar.enc c3c07eff51 update building for .hex, secrets moving 7 years ago
shell.nix 5e52eda0ca shell.nix: Packages relocated in upstream cleanup 6 years ago
testlist.mk 30f22d450d Add basic infrastrucure for building full tests 8 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 hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

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 Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.