/qmk_firmware

keyboard controller firmware for Atmel AVR and ARM USB families
  1. C 77.0%
  2. C++ 14.4%
  3. Makefile 5.3%
  4. Objective-C 1.2%
  5. Assembly 0.7%
  6. Python 0.4%
  7. Other 1.0%
C C++ Makefile Objective-C Assembly Python Other
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Find file
Switch branches/tags
preonic-2.0 preonic-1.0 planck-5.0 planck-4.2 planck-4.1 planck-4.0 ergodox_ez-161205 LUFA-170418 LUFA-151115 LUFA-140928 LUFA-140302 LUFA-130901 LUFA-130901-BETA LUFA-111009 0.5.264 0.5.263 0.5.262 0.5.261 0.5.260 0.5.259 0.5.258 0.5.257 0.5.256 0.5.255 0.5.254 0.5.253 0.5.252 0.5.251 0.5.250 0.5.249 0.5.248 0.5.247 0.5.246 0.5.245 0.5.244 0.5.243 0.5.242 0.5.241 0.5.240 0.5.239 0.5.238 0.5.237 0.5.236 0.5.235 0.5.234 0.5.233 0.5.232 0.5.231 0.5.230 0.5.229 0.5.228 0.5.227 0.5.226 0.5.225 0.5.224 0.5.223 0.5.222 0.5.221 0.5.220 0.5.219 0.5.218 0.5.217 0.5.216 0.5.215 0.5.214 0.5.213 0.5.212 0.5.211 0.5.210 0.5.209 0.5.208 0.5.207 0.5.206 0.5.205 0.5.204 0.5.203 0.5.202 0.5.201 0.5.200 0.5.199 0.5.198 0.5.197 0.5.196 0.5.195 0.5.194 0.5.193 0.5.192 0.5.191 0.5.190 0.5.189 0.5.188 0.5.187 0.5.186 0.5.185 0.5.184 0.5.183 0.5.182 0.5.181 0.5.180 0.5.179
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode Add EditorConfig file (#1930) Oct 31, 2017
docs Fix custom functions documation for layer_state_set* Mar 24, 2018
drivers update to driver separation Sep 16, 2017
keyboards Added basic support for JJ50 (preonic-like based on atmega32A) (#2546) Mar 24, 2018
layouts Just personal layout tweaks :) (#2557) Mar 23, 2018
lib Merge ChibiOS and LUFA descriptor support (#2362) Feb 8, 2018
quantum Add macro for momentarily switching to a layer while some mods are ac… Mar 21, 2018
tests add tests for action_layer.c and reset layer state after tests Dec 15, 2017
tmk_core Generate API docs from source code comments (#2491) Mar 22, 2018
users Add Pretty Keymaps to Ergodox EZ Mar 21, 2018
util fix the moxygen invocation Mar 24, 2018
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) Dec 12, 2017
.editorconfig Fix .editorconfig to not mess with line endings Feb 3, 2018
.gitattributes Squashed 'lib/lufa/' changes from 385d403..a44056fb9 Jul 7, 2017
.gitignore Generate API docs from source code comments (#2491) Mar 22, 2018
.gitmodules Update .gitmodules Nov 16, 2017
.travis.yml Generate API docs from source code comments (#2491) Mar 22, 2018
CODE_OF_CONDUCT.md create initial code of conduct Jun 28, 2017
Dockerfile Reverting CMD Changes Aug 19, 2017
Doxyfile Generate API docs from source code comments (#2491) Mar 22, 2018
LICENSE add an explicit lisence file for github to pickup Nov 14, 2017
Makefile Added a clean target to remove build artifacts Mar 16, 2018
Vagrantfile Update some obsolete references Jul 30, 2016
autocomplete.sh Make arguments redo, subproject elimination (#1784) Oct 14, 2017
book.json adds redirects for docs Aug 19, 2017
bootloader.mk Updates bootloader settings, adds file size check (#2029) Nov 28, 2017
build_full_test.mk Add SRC and OPT_DEFS when building tests Jul 20, 2017
build_keyboard.mk Merge ChibiOS and LUFA descriptor support (#2362) Feb 8, 2018
build_layout.mk Creates a layouts/ folder for keymaps shared between keyboards (#1609) Aug 24, 2017
build_test.mk Split common.mk into common.mk and common_features.mk Jun 18, 2017
common.mk Start mvoing hardware drivers to /drivers/ (#1433) Jul 10, 2017
common_features.mk Rule to enable Modifiers with Auto-Shift (#2542) Mar 16, 2018
doxygen-todo Generate API docs from source code comments (#2491) Mar 22, 2018
license_GPLv2.md Clarify the quantum license (#1042) Mar 28, 2017
license_GPLv3.md Clarify the quantum license (#1042) Mar 28, 2017
license_Modified_BSD.md Clarify the quantum license (#1042) Mar 28, 2017
message.mk Reset color after submodule warning message Jan 12, 2018
readme.md Found some broken links while looking up ARM keyboard support Dec 15, 2017
secrets.tar.enc update building for .hex, secrets moving Aug 22, 2017
shell.nix shell.nix: add teensy loader Nov 26, 2017
testlist.mk Add basic infrastrucure for building full tests Jun 18, 2017

readme.md

Quantum Mechanical Keyboard Firmware

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

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.

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, and the Clueboard by Zach White.

Documentation

https://docs.qmk.fm is 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.