Go to file
Joel Challis 1b93d576f8
Fix ccache default (#14906)
2021-10-22 10:21:43 +11:00
.github Remove bin/qmk (#14231) 2021-08-29 16:50:22 -07:00
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2021-10-15 11:54:19 +11:00
api_data
data [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2021-10-18 16:23:20 +11:00
docs Align PS/2 GPIO defines (#14745) 2021-10-20 20:07:40 +01:00
drivers Relocate PS2 code (#14895) 2021-10-20 21:18:49 +01:00
keyboards Tidy up LCD_ENABLE/visualizer references (#14855) 2021-10-20 21:27:46 +01:00
layouts Tidy up LCD_ENABLE/visualizer references (#14855) 2021-10-20 21:27:46 +01:00
lib Split out HAPTIC_ENABLE to have separate DRIVER option (#14854) 2021-10-18 12:55:44 +01:00
platforms Relocate PS2 code (#14895) 2021-10-20 21:18:49 +01:00
quantum Merge remote-tracking branch 'origin/master' into develop 2021-10-20 03:51:11 +00:00
tests [Core] Fix "6kro enable" and clarify naming (#14563) 2021-09-29 11:37:11 -07:00
tmk_core Fix ccache default (#14906) 2021-10-22 10:21:43 +11:00
users Tidy up LCD_ENABLE/visualizer references (#14855) 2021-10-20 21:27:46 +01:00
util [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2021-10-18 16:23:20 +11: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 New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 2021-09-16 14:59:57 +10:00
.gitmodules Purge uGFX. (#14720) 2021-10-07 10:57:48 +11:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile
LICENSE
Makefile Remove legacy Makefile functionality (#14858) 2021-10-18 00:15:26 +01: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 [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2021-10-18 16:23:20 +11:00
build_full_test.mk
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 Rename platform SRC variable (#14894) 2021-10-20 21:04:23 +01: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 Infer more when building features (#13890) 2021-10-17 22:37:48 +01:00
common.mk Relocate platform specific drivers (#13894) 2021-08-17 23:43:09 +01:00
common_features.mk Tidy up LCD_ENABLE/visualizer references (#14855) 2021-10-20 21:27:46 +01:00
disable_features.mk Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
generic_features.mk Split out HAPTIC_ENABLE to have separate DRIVER option (#14854) 2021-10-18 12:55:44 +01: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
shell.nix Remove bin/qmk (#14231) 2021-08-29 16:50:22 -07:00
show_options.mk Tidy up LCD_ENABLE/visualizer references (#14855) 2021-10-20 21:27:46 +01:00
testlist.mk Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11: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.