Open-source keyboard firmware for Atmel AVR and Arm USB families
Go to file
Joel Challis 6d84795bc1
Update ARM split keyboard docs (#9160)
* Update ARM split keyboard docs

* Update docs/serial_driver.md

Co-authored-by: Nick Brassel <nick@tzarc.org>

Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-22 06:20:46 +10:00
.github Update cli CI checkout to v2 (#8823) 2020-04-19 09:08:12 +02:00
.vscode Allow trailing whitespace in markdown docs, for formatting purposes. (#8774) 2020-04-13 11:31:40 +10:00
bin Move everything to Python 3.6 (#8835) 2020-04-18 22:00:56 +02:00
docs Update ARM split keyboard docs (#9160) 2020-05-22 06:20:46 +10:00
drivers Initial arm serial partially based on old lets split code 2020-05-21 18:04:30 +01:00
keyboards [Keyboard] Add support for Ace of Spades TKL keyboard (#9128) 2020-05-21 12:49:35 -07:00
layouts Update j3rn keymap (#9100) 2020-05-16 04:14:47 +10:00
lib CLI: Rework submodule checking (#9162) 2020-05-21 21:56:43 +02:00
quantum Initial arm serial partially based on old lets split code (#7072) 2020-05-21 19:39:51 +01:00
tests format code according to conventions [skip ci] 2020-03-13 18:44:56 +00:00
tmk_core Allow for overriding RAW endpoint usage page and ID. (#8834) 2020-05-21 20:31:42 +10:00
users Art userspace (#9068) 2020-05-19 22:05:32 +01:00
util CLI: Improve experience when running qmk setup on FreeBSD. (#8798) 2020-05-20 08:09:13 -07:00
.clang-format
.editorconfig
.gitattributes
.gitignore Remove old setup scripts (#8811) 2020-04-16 00:32:40 +01:00
.gitmodules Revert "Fix conflicting types for 'tfp_printf' (#8269)" 2020-05-04 09:25:44 -07:00
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 2020-01-19 13:59:57 -08:00
book.json
bootloader.mk Add LUFA mass storage BOOTLOADER "support" (#7729) 2019-12-29 20:53:23 +00: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 Align some ChibiOS build logic (#8461) 2020-03-22 20:48:17 +11:00
build_layout.mk
build_test.mk Initial arm->chibios pass - simplify some platform logic (#8450) 2020-03-21 16:20:04 +11:00
CODE_OF_CONDUCT.md
common_features.mk Add SPI 25xx EEPROM support. (#8780) 2020-05-19 10:34:00 +10:00
common.mk
Dockerfile
Doxyfile
doxygen-todo Remove Bluefruit protocol (#9008) 2020-05-04 23:05:45 +01:00
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile Remove broken example from Makefile (#9159) 2020-05-21 20:33:20 +01:00
message.mk Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 2020-02-10 04:19:08 +11:00
nose2.cfg
readme.md Breaking Changes documentation fixes 2020-02-29 12:30:38 -08:00
requirements-dev.txt Use milc for config check, requirements fixes 2020-04-08 09:31:14 -07:00
requirements.txt CLI: Add development mode support 2020-04-08 09:31:14 -07:00
secrets.tar.enc
setup.cfg
shell.nix Fix up Arm builds with nix-shell. (#8312) 2020-03-07 03:05:51 +11:00
show_options.mk Remove unused LED_BREATHING_TABLE 2020-03-06 22:29:01 -08:00
testlist.mk
Vagrantfile Remove broken example from Makefile (#9159) 2020-05-21 20:33:20 +01:00

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.