Go to file
Alexis Jeandeau b5d24f9efb
Call steno_set_mode inside eeconfig_init_user in the doc (#15176)
2021-11-17 22:30:42 +00:00
.github Auto-create PRs for merged formatting issues (#15157) 2021-11-17 20:05:12 +00:00
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2021-10-15 11:54:19 +11:00
api_data
bin Ensure that safe_commands always run (#13199) 2021-06-14 16:51:58 -07:00
data Refactor new-keyboard to be python3.7 compatible (#14707) 2021-11-05 08:14:43 +11:00
docs Call steno_set_mode inside eeconfig_init_user in the doc (#15176) 2021-11-17 22:30:42 +00:00
drivers Format code according to conventions (#15193) 2021-11-18 07:28:38 +11:00
keyboards [Keyboard] Move encoder hacks into via keymaps for Work Louder boards (#15192) 2021-11-17 20:54:12 +00:00
layouts [Keymap] Revamp the ergodox french_hacker layout (#15064) 2021-11-05 11:27:48 -07:00
lib Partially reinstate CI formatting process (#15155) 2021-11-14 23:06:22 +00:00
platforms Format code according to conventions (#15193) 2021-11-18 07:28:38 +11:00
quantum Format code according to conventions (#15193) 2021-11-18 07:28:38 +11:00
tests [Core] Fix "6kro enable" and clarify naming (#14563) 2021-09-29 11:37:11 -07:00
tmk_core Format code according to conventions (#15193) 2021-11-18 07:28:38 +11:00
users [Keymap] updates for oled, and diablo 2 layer - Drashna (#15194) 2021-11-17 12:45:50 -08:00
util Cleanup issues identified by lgtm (#14459) 2021-09-27 10:02:54 -07:00
.clang-format
.editorconfig
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
.gitignore Align some quantum sub-directories (#14134) 2021-08-24 17:07:11 +01:00
.gitmodules
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile
LICENSE
Makefile Allow community layouts to be specified in info.json (#14682) 2021-10-04 09:26:19 -07:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
book.json
bootloader.mk Allow AVR Bootloader size to be configurable (#14783) 2021-10-11 14:30:17 +01:00
build_full_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
build_json.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2021-08-18 21:52:41 +01:00
build_keyboard.mk Fix issues with recent keymap.json changes (#14089) 2021-08-20 19:11:49 +10:00
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2021-08-18 21:52:41 +01:00
build_test.mk eeprom_stm32: implement high density wear leveling (#12567) 2021-08-23 23:15:34 +01:00
common.mk Relocate platform specific drivers (#13894) 2021-08-17 23:43:09 +01:00
common_features.mk Bugfix for Joystick and JSON schema (#14295) 2021-09-09 10:27:58 +10:00
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 2021-01-30 13:08:58 -08:00
doxygen-todo Various fixes from reorg of files (#14051) 2021-08-18 09:54:41 +10:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Move "firmware size check skipped" note to message.mk (#14632) 2021-09-29 06:08:46 +10:00
nose2.cfg
readme.md [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2021-06-07 16:30:55 -07:00
requirements.txt switch to qmk-dotty-dict (#13460) 2021-07-14 09:08:48 -07:00
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
shell.nix Update the nix-shell environment (#13316) 2021-08-29 22:24:43 +01:00
show_options.mk Remove unused KEYBOARD_LOCK_ENABLE from rules (#14920) 2021-10-25 21:14:46 -07:00
testlist.mk eeprom_stm32: implement high density wear leveling (#12567) 2021-08-23 23:15:34 +01:00

readme.md

Quantum Mechanical Keyboard Firmware

Current Version 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.