Go to file
Ryan 00c1401d3c
Documentation for keymap_extras (#9194)
2020-05-27 01:52:48 +01: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 Documentation for keymap_extras (#9194) 2020-05-27 01:52:48 +01:00
drivers ISSI driver compile error fix (#9169) 2020-05-27 01:18:13 +01:00
keyboards Adding TGR Tris/Tris CE Numpad (#9139) 2020-05-27 01:20:32 +01:00
layouts [Keymap] dohmain 60_tsangan_hhkb layout (#9157) 2020-05-21 19:51:36 -07:00
lib Fix the path for generated keymaps (#9213) 2020-05-26 15:18:49 -07:00
quantum Fix build. (#9163) 2020-05-22 06:25:03 +10:00
tests format code according to conventions [skip ci] 2020-03-13 18:44:56 +00:00
tmk_core Fix capitalisation of "GitHub" (#9184) 2020-05-25 19:43:14 -07: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
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Improve the Makefile message a bit more (#9161) 2020-05-22 00:28:55 +01:00
Vagrantfile Remove broken example from Makefile (#9159) 2020-05-21 20:33:20 +01:00
book.json
bootloader.mk
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
common.mk
common_features.mk Add SPI 25xx EEPROM support. (#8780) 2020-05-19 10:34:00 +10:00
doxygen-todo Remove Bluefruit protocol (#9008) 2020-05-04 23:05:45 +01:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
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

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.