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.
 
 
 
 
 
 
Collin J. Doering a592e7b7ce
Modify location of F# keys in lower/raise layers
2 years ago
.github Force "blank" issue template to end of list (#8387) 2 years ago
.vscode Highlight .inc files as .c files (#8496) 2 years ago
bin CLI: More MSYS2 fixes (#8577) 2 years ago
docs add japanese translation (feature part 01) (#8196) 2 years ago
drivers Fix AVR ws2812 when ADDRESS_BASE is non zero (#8646) 2 years ago
keyboards Modify location of F# keys in lower/raise layers 2 years ago
layouts jotix layouts (#8644) 2 years ago
lib Doctor: Add avrdude/dfu-util/dfu-programmer version printing (#8678) 2 years ago
quantum Add Greek keymap (#8636) 2 years ago
tests format code according to conventions [skip ci] 2 years ago
tmk_core format code according to conventions [skip ci] 2 years ago
users [Keymap] sigul Planck layout updates (#8649) 2 years ago
util Miscellaneous cleanups (#8639) 2 years ago
.clang-format fix indent size 3 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 2 years ago
.gitattributes Set eep files to binary mode 5 years ago
.gitignore 2020 February 29 Breaking Changes Update (#8064) 2 years ago
.gitmodules Track master branches for lib/chibios, lib/chibios-contrib, lib/ugfx. (#8273) 2 years ago
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 2 years 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) 4 years ago
LICENSE add an explicit lisence file for github to pickup 4 years ago
Makefile 2020 February 29 Breaking Changes Update (#8064) 2 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 4 years ago
book.json adds redirects for docs 4 years ago
bootloader.mk Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 4 years ago
build_json.mk Rename qmk json-keymap to qmk json2c (#8372) 2 years ago
build_keyboard.mk Align some ChibiOS build logic (#8461) 2 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 3 years ago
build_test.mk Initial arm->chibios pass - simplify some platform logic (#8450) 2 years ago
common.mk Move Split Common VPATH addition (#4716) 3 years ago
common_features.mk Add Word Per Minute calculation feature (#8054) 2 years ago
doxygen-todo Remove PJRC USB stack 2 years ago
license_GPLv2.md Clarify the quantum license (#1042) 5 years ago
license_GPLv3.md Clarify the quantum license (#1042) 5 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 5 years ago
message.mk Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 2 years ago
nose2.cfg Setup a python test framework 2 years ago
readme.md Breaking Changes documentation fixes 2 years ago
requirements.txt Drop bs4 dependency, update docs, minor improvements 2 years ago
secrets.tar.enc update building for .hex, secrets moving 4 years ago
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 2 years ago
shell.nix Fix up Arm builds with nix-shell. (#8312) 2 years ago
show_options.mk Remove unused LED_BREATHING_TABLE 2 years ago
testlist.mk Add basic infrastrucure for building full tests 5 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.