Go to file
Felix Jen 05ac139a29
Updated README name (#11033)
2020-11-29 17:52:22 +00:00
.github identify the qmk-bot 2020-11-22 08:07:45 -08:00
.vscode [Keyboard] add rhymestone by marksard (#9708) 2020-09-04 04:14:34 -07:00
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
bin Move everything to Python 3.6 (#8835) 2020-04-18 22:00:56 +02:00
docs 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
drivers 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
keyboards Updated README name (#11033) 2020-11-29 17:52:22 +00:00
layouts 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
lib 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
platforms/chibios 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
quantum 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
tests
tmk_core 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
users 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
util Refactor qmk_install.sh (#10681) 2020-11-26 14:37:54 +00:00
.clang-format
.editorconfig
.gitattributes
.gitignore Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 2020-05-30 13:14:59 -07:00
.travis.yml CI: Add docs build and deploy workflow (#7448) 2020-11-10 07:00:40 -08:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
Vagrantfile Remove broken example from Makefile (#9159) 2020-05-21 20:33:20 +01:00
book.json
bootloader.mk Fix STM32duino bootloader (#10648) 2020-10-15 02:55:31 +01:00
build_full_test.mk
build_json.mk Load keymap-level rules.mk when compiling keymap.json (#8841) 2020-04-18 14:29:48 +01:00
build_keyboard.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
build_layout.mk Allow for building layouts from keymap.json files. 2020-07-07 07:27:39 -07:00
build_test.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common_features.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
doxygen-todo Remove iWRAP protocol (#9284) 2020-08-29 14:30:02 -07:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
nose2.cfg
readme.md Revert "Branch point for 2020 Aug 29 Breaking Change" 2020-08-29 14:30:02 -07:00
requirements-dev.txt
requirements.txt 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
secrets.tar.enc
setup.cfg
shell.nix Update shell.nix (#10712) 2020-10-23 17:50:05 +11:00
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
testlist.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00

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.