You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Manna Harbour aebc99a4e0 [miryoku-github] Delete .github/ and readme.md 3 years ago
.vscode Exclude uf2 files in VS Code (#18186) 3 years ago
builddefs Add step summary output to CI builds, with failure logs. (#20288) 3 years ago
data Update keycodes_0.0.1_basic.hjson (#20129) 3 years ago
docs Add additional options for Drag Scroll config (#20523) 3 years ago
drivers Remove usages of config_common.h from config.h files. (#19714) 3 years ago
keyboards [Keyboard] Add 1upkeyboards pi50 (#20242) 3 years ago
layouts [Keymap] Drashna updates for 0.20.0 (#19960) 3 years ago
lib Add autocomplete to generate-compilation-database (#20387) 3 years ago
platforms Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 years ago
quantum Fix MATRIX_HAS_GHOST when MATRIX_COL > 16 (#20093) 3 years ago
tests VIA Protocol 12 + fixes (#19916) 3 years ago
tmk_core Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 3 years ago
users Add peterfalken userspace & keymaps (#19897) 3 years ago
util Add Discord webhook at end of each CI run. (#20355) 3 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Reject info.json at keymap level (#20408) 3 years ago
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 3 years ago
Dockerfile
Doxyfile
LICENSE
Makefile Remove `make all-<platform>` build targets (#19496) 3 years ago
Vagrantfile
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk Remove quantum/audio from global VPATH (#18753) 3 years ago
requirements-dev.txt
requirements.txt Align CLI requirements (#18117) 3 years ago
setup.cfg
shell.nix Nix shell updates for `develop` (#18131) 3 years ago

docs/README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains QMK Firmware, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation with the help of community members like you.

Get Started

?> Basic QMK Configurator
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
More powerful, but harder to use.

Make It Yours

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.

Need help?

Check out the support page to see how you can get help using QMK.

Give Back

There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.