No Description

Jumail Mundekkat 149015e799 Fixed grep issue in bootloader build target (#3848) 6 years ago
.github 3a3de84e40 Tweak issue templates (capitalisation mostly) (#5133) 6 years ago
.vscode 05be1de1aa Xton's first keymap! (#2941) 7 years ago
docs efef54032b [Docs] Add section about EEPROM on ARM (#5070) 6 years ago
drivers 2cee371bf1 Haptic feedback generalized - DRV2605 and solenoids (#4939) 6 years ago
keyboards 0cee0764fd Fix Espectro Mac keymap and add new layout option (#4923) 6 years ago
layouts 545f95c8f4 Migrate ACTION_LAYER_TAP_TOGGLEs to TT() 6 years ago
lib 6c086f2b6d Revert changes to chibiOS-contrib (#4176) 6 years ago
quantum feee01192e Fix Audio Clicky by adding missing punctuation (#5171) 6 years ago
tests 3ea7c2a434 Remove empty action_function() 6 years ago
tmk_core 149015e799 Fixed grep issue in bootloader build target (#3848) 6 years ago
users 5cb713148d Change Command keycode defaults to match corresponding Bootmagic codes (#5078) 6 years ago
util 1a6a2a7b75 Relocate usb_detach to utils (#5121) 6 years ago
.clang-format ae9439a3f9 Add .clang-format file 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 6b4549da8c Add Satisfaction75 to QMK, Enable EEPROM on stm32f072 (#5094) 6 years ago
.gitmodules 41f3f01167 Update .gitmodules 7 years ago
.travis.yml d3f7910e68 Remove AUTOGEN and fix Travis Compiled Push scripts (#5077) 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 612dc232d7 Add distclean target instead 6 years ago
Vagrantfile 37b042a594 Initial fixes for vagrant (#4900) 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 7 years ago
build_keyboard.mk 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 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) 6 years ago
common_features.mk 2cee371bf1 Haptic feedback generalized - DRV2605 and solenoids (#4939) 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
show_options.mk d5bc7fc157 Add makefile target 'show_build_options' and 'show_all_features' (#5048) 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.