No Description

James Young cabe4dfa72 [Keyboard] VIA Support for Boardwalk (#8124) 5 years ago
.github 75e7018f72 CI: Add workflow for CLI testing (#7357) 5 years ago
.vscode f069e9fc09 Generalize Tap Dance Layer functions (#6629) 5 years ago
bin 0ed492978a Add pep8-naming to our python linting 5 years ago
docs e77188458f Add QMK Compile Context Sensitivity (#6884) 5 years ago
drivers 8e550fc11a Add thread safety around i2c_master for ChibiOS/ARM. 5 years ago
keyboards cabe4dfa72 [Keyboard] VIA Support for Boardwalk (#8124) 5 years ago
layouts 707c04b4ab [Keymap] Add users/alfrdmalr and switch to layouts (#8030) 5 years ago
lib b6e23f974b Update the flash cli command to use the user config (#8125) 5 years ago
quantum 307be48de9 Reduce SPLIT_USB_TIMEOUT by 500ms (#7637) 5 years ago
tests b624f32f94 clang-format changes 5 years ago
tmk_core c3200aa8fc Compile error if ONESHOT_TIMEOUT defined but oneshot disabled (#8100) 5 years ago
users 707c04b4ab [Keymap] Add users/alfrdmalr and switch to layouts (#8030) 5 years ago
util 75e7018f72 CI: Add workflow for CLI testing (#7357) 5 years ago
.clang-format c3c61dc76e fix indent size 6 years ago
.clang_complete 98ac32b417 Vim Layout for Ergodox-EZ (mac only) (#2112) 7 years ago
.editorconfig a25dd58bc5 QMK CLI and JSON keymap support (#6176) 5 years ago
.gitattributes de58ec9738 Set eep files to binary mode 8 years ago
.gitignore 74e3cad728 Remove entries for Minidox eep files from gitignore (#8077) 5 years ago
.gitmodules 39baa5e80d add lufa as a submodule 5 years ago
.travis.yml 65f7bfcc8d Fix unknown key 'IndentPPDirectives' on CI (#7933) 5 years ago
CODE_OF_CONDUCT.md e243afe23e updates the coc 5 years ago
Dockerfile d8253b83e8 Update docker util script and travis to use new base container 5 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 d2115f7d1c Allow 'make all:<user>' to not build EVERYTHING (#7402) 5 years ago
Vagrantfile 29e9caa82b Configure Vagrant to use qmk_base_container (#6194) 5 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 559ef21563 Add LUFA mass storage `BOOTLOADER` "support" (#7729) 5 years ago
build_full_test.mk a5b0f4de35 Add SRC and OPT_DEFS when building tests 7 years ago
build_json.mk 15e5f57952 Add JSON keymap to prereq list of C keymap 5 years ago
build_keyboard.mk 0f95c0865c add 'objs-size' target into tmk_core/avr.mk (#5490) 5 years ago
build_layout.mk 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 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 393937b43f Relocate grave keycode processing (#8082) 5 years ago
doxygen-todo 174a15d07d Remove PJRC USB stack 5 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 6052aa499e Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 5 years ago
nose2.cfg 5b7a5b2a76 Setup a python test framework 5 years ago
readme.md 3c190f8927 Improve docs "Edit Document" footer 5 years ago
requirements.txt 0ed492978a Add pep8-naming to our python linting 5 years ago
secrets.tar.enc c3c07eff51 update building for .hex, secrets moving 7 years ago
setup.cfg f7bdc54c69 Add flake8 to our test suite and fix all errors (#7379) 5 years ago
shell.nix 8dc9764f31 Fix shell.nix by pinning nixpkgs (#6213) 5 years ago
show_options.mk 4139de3cc9 Fix AVR boards which were overriding backlight without setting… (#8044) 5 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 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.