No Description

Danny a40dbf94e8 Merge pull request #6264 from zvecr/split_master_check 6 years ago
.github 3a3de84e40 Tweak issue templates (capitalisation mostly) (#5133) 6 years ago
.vscode 05be1de1aa Xton's first keymap! (#2941) 7 years ago
bin a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 years ago
docs 001a6c24ae [Docs] Clarify Zadig usage in FAQ Docs (#6360) 6 years ago
drivers 5fa0a274ea Align ARM i2c_readReg with AVR (#6314) 6 years ago
keyboards 6b1db7da23 Fix Numbrero Handwired make example in readme 6 years ago
layouts 455f15528c Jotix (#6355) 6 years ago
lib f859375284 Expand bootloader target to support most AVR boards (#6255) 6 years ago
quantum a40dbf94e8 Merge pull request #6264 from zvecr/split_master_check 6 years ago
tests 3ea7c2a434 Remove empty action_function() 6 years ago
tmk_core 3895b4b868 Extend maximum number of backlight levels to 31 (#6351) 6 years ago
users e2dfb787da Adding rgb matrix speed into eeprom storage. (#5965) 6 years ago
util 29e9caa82b Configure Vagrant to use qmk_base_container (#6194) 6 years ago
.clang-format c3c61dc76e fix indent size 6 years ago
.clang_complete 98ac32b417 Vim Layout for Ergodox-EZ (mac only) (#2112) 8 years ago
.editorconfig a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 years ago
.gitattributes de58ec9738 Set eep files to binary mode 9 years ago
.gitignore a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 years ago
.gitmodules 41f3f01167 Update .gitmodules 8 years ago
.travis.yml 0a03f7cff7 Update docker util script and travis to use new base container 6 years ago
CODE_OF_CONDUCT.md ea7bb624de Update CODE_OF_CONDUCT.md 7 years ago
Dockerfile d8253b83e8 Update docker util script and travis to use new base container 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 8 years ago
Makefile 99500243e1 Make python a required build dependency (#5784) 6 years ago
Vagrantfile 29e9caa82b Configure Vagrant to use qmk_base_container (#6194) 6 years ago
autocomplete.sh 800ec55dfc Make arguments redo, subproject elimination (#1784) 8 years ago
book.json d8145c8464 adds redirects for docs 8 years ago
bootloader.mk 3538955778 Usbasploader bootloader option addition (#6304) 6 years ago
build_full_test.mk a5b0f4de35 Add SRC and OPT_DEFS when building tests 8 years ago
build_json.mk 7d557a0514 Fix compiling json files. (#6340) 6 years ago
build_keyboard.mk 0f95c0865c add 'objs-size' target into tmk_core/avr.mk (#5490) 6 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) 7 years ago
common_features.mk 6cccc22be9 Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 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 8e348c427d Display firmware size percentage (#6307) 6 years ago
readme.md 8680c50d07 Removes Erez personally from QMK (#5883) 6 years ago
requirements.txt a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 years ago
secrets.tar.enc c3c07eff51 update building for .hex, secrets moving 8 years ago
setup.cfg a25dd58bc5 QMK CLI and JSON keymap support (#6176) 6 years ago
shell.nix 72df7b4c19 shell.nix: Downgrade gcc-arm-embedded (#5913) 6 years ago
show_options.mk 7e655a207e Add option to enable LTO easily (#5674) 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 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.