You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Stefan Kerkmann e50867d52d
[Core] Add support for RISC-V builds and GD32VF103 MCU (#12508)
2 years ago
.github Remove bin/qmk (#14231) 2 years ago
.vscode remove Bracket Pair Colorizer recommendation (#14816) 2 years ago
api_data Generate api data on each push (#10609) 3 years ago
data [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
docs [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
drivers [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
keyboards [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
layouts Merge remote-tracking branch 'origin/master' into develop 2 years ago
lib [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
platforms [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
quantum [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
tests [Core] Fix "6kro enable" and clarify naming (#14563) 2 years ago
tmk_core [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
users Merge remote-tracking branch 'origin/master' into develop 2 years ago
util [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
.clang-format fix indent size 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 3 years ago
.gitignore New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 2 years ago
.gitmodules Purge uGFX. (#14720) 2 years ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile Remove legacy Makefile functionality (#14858) 2 years ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
build_full_test.mk Ensure single newline at EOF for core files (#11310) 3 years ago
build_json.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2 years ago
build_keyboard.mk Infer more when building features (#13890) 2 years ago
build_layout.mk Add config.h and rules.mk support for data driven keymaps (#12859) 2 years ago
build_test.mk Infer more when building features (#13890) 2 years ago
common.mk Relocate platform specific drivers (#13894) 2 years ago
common_features.mk [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 2 years ago
disable_features.mk Remove SERIAL_LINK feature (#14727) 2 years ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 2 years ago
generic_features.mk Infer more when building features (#13890) 2 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk Move "firmware size check skipped" note to message.mk (#14632) 2 years ago
nose2.cfg Setup a python test framework 4 years ago
readme.md [Core] [Docs] Remove travis-ci references (#13916) 2 years ago
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 2 years ago
requirements.txt switch to qmk-dotty-dict (#13460) 2 years ago
setup.cfg Use the schema to eliminate custom code (#11108) 3 years ago
shell.nix Remove bin/qmk (#14231) 2 years ago
show_options.mk Move converter specific tmk_core protocols (#14743) 2 years ago
testlist.mk Remove SERIAL_LINK feature (#14727) 2 years ago

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.