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.
QMK Bot b5725c05bd Merge remote-tracking branch 'origin/master' into develop 4 years ago
..
ChangeLog Changelog 2022q1 (#16380) 4 years ago
gitbook/images
internals Move Doxygen docs to subdirectory (#16561) 4 years ago
ja Merge remote-tracking branch 'origin/master' into develop 4 years ago
zh-cn Merge remote-tracking branch 'origin/master' into develop 4 years ago
.nojekyll
CNAME
README.md
_langs.md Remove stale docs translations (#15737) 4 years ago
_summary.md [Core] Add Caps Word feature to core (#16588) 4 years ago
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
api_overview.md
arm_debugging.md
audio_driver.md
breaking_changes.md Changelog 2022q1 (#16380) 4 years ago
breaking_changes_history.md Changelog 2022q1 (#16380) 4 years ago
breaking_changes_instructions.md
chibios_upgrade_instructions.md
cli.md
cli_commands.md Quantum Painter (#10174) 4 years ago
cli_configuration.md
cli_development.md Some docs improvements (#15845) 4 years ago
cli_tab_complete.md
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md Add L432, L442. (#16016) 4 years ago
config_options.md [Core] Add compile/make macro to core (#15959) 4 years ago
configurator_architecture.md
configurator_default_keymaps.md
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 4 years ago
configurator_troubleshooting.md
contributing.md update the Chinese translation based on the latest English version (#14924) 4 years ago
custom_matrix.md
custom_quantum_functions.md Point out that deferred execution needs to be enabled in rules.mk (#16196) 4 years ago
data_driven_config.md Change data driven "str" type to represent a quoted string literal (#16516) 4 years ago
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
easy_maker.md update the Chinese translation based on the latest English version (#14924) 4 years ago
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md Keymap FAQ updates (#17130) 4 years ago
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md Rename `AdafruitBLE` to `BluefruitLE` (#16127) 4 years ago
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 4 years ago
feature_caps_word.md [Core] Add Caps Word feature to core (#16588) 4 years ago
feature_combo.md New combo configuration options (#15083) 4 years ago
feature_command.md
feature_debounce_type.md Add sym_defer_pr debouncer type (#14948) 4 years ago
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_encoders.md Add support for encoder mapping. (#13286) 4 years ago
feature_grave_esc.md Rename some Quantum keycodes (#15968) 4 years ago
feature_haptic_feedback.md [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 4 years ago
feature_hd44780.md HD44780 driver rework (#16370) 4 years ago
feature_joystick.md Joystick feature updates (#16732) 4 years ago
feature_key_lock.md
feature_key_overrides.md
feature_layers.md
feature_layouts.md
feature_leader_key.md [Docs] Update feature_leader_key.md (#16344) 4 years ago
feature_led_indicators.md Refine LED indicator documentation (#16304) 4 years ago
feature_led_matrix.md [Docs] Align LED Matrix docs with RGB matrix docs (#17140) 4 years ago
feature_macros.md [Docs] feature_macro.md: minor formatting fix (#16205) 4 years ago
feature_midi.md Move Doxygen docs to subdirectory (#16561) 4 years ago
feature_mouse_keys.md Merge remote-tracking branch 'origin/master' into develop 4 years ago
feature_oled_driver.md [Docs] OLED documentation edits (#15977) 4 years ago
feature_pointing_device.md Add support for multiple sensors to pmw3360 (#15996) 4 years ago
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Merge remote-tracking branch 'origin/master' into develop 4 years ago
feature_rgblight.md rgblight: Add functions to stop blinking one or all but one layer (#16859) 4 years ago
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Merge remote-tracking branch 'origin/master' into develop 4 years ago
feature_st7565.md
feature_stenography.md [Docs] Update Steno Keycode Table (#17155) 4 years ago
feature_swap_hands.md Add support for encoder mapping. (#13286) 4 years ago
feature_tap_dance.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md Remove `send_unicode_hex_string()` (#16518) 4 years ago
feature_userspace.md
feature_velocikey.md
feature_wpm.md Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 years ago
flash_driver.md Added external spi flash driver. (#15419) 4 years ago
flashing.md Add flash target for UF2 bootloaders (#16525) 4 years ago
flashing_bootloadhid.md
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
gpio_control.md Move Doxygen docs to subdirectory (#16561) 4 years ago
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 years ago
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md Fix i2c driver doc: Incorrect name (#16898) 4 years ago
index.html Fix anchors with <code> in table of content (#15169) 4 years ago
isp_flashing_guide.md ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 4 years ago
keycodes.md [Core] Add Caps Word feature to core (#16588) 4 years ago
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
keymap.md Some docs improvements (#15845) 4 years ago
mod_tap.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
newbs.md
newbs_building_firmware.md [Docs] Update newbs_building_firmware.md (#16333) 4 years ago
newbs_building_firmware_configurator.md
newbs_flashing.md [Docs] newbs_flashing.md: add link to build environment section (#15654) 4 years ago
newbs_getting_started.md Recommend pillow as part of manual MSYS install (#17133) 4 years ago
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md Add Atom editor suggestion (#15969) 4 years ago
newbs_testing_debugging.md
one_shot_keys.md
other_eclipse.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
other_vscode.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 years ago
platformdev_chibios_earlyinit.md Fixes for bootloader refactor build failures (#15638) 4 years ago
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md Align new-keyboard with recent schema updates (#16378) 4 years ago
power.txt
pr_checklist.md Update pr_checklist.md (#17122) 4 years ago
proton_c_conversion.md Move Doxygen docs to subdirectory (#16561) 4 years ago
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md [Core] Add Reboot keycode to core (#15990) 4 years ago
quantum_painter.md Quantum Painter (#10174) 4 years ago
quantum_painter_qff.md Quantum Painter (#10174) 4 years ago
quantum_painter_qgf.md Quantum Painter (#10174) 4 years ago
quantum_painter_rle.md Quantum Painter (#10174) 4 years ago
redirects.json
ref_functions.md Fix typo in docs/ref_functions.md (#16690) 4 years ago
reference_configurator_support.md
reference_glossary.md
reference_info_json.md Fix in-page links in reference_info_json.md (#16487) 4 years ago
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 4 years ago
serial_driver.md
spi_driver.md
squeezing_avr.md [Core] Allow usage of AVRs minimal printf library (#16266) 4 years ago
support.md
sw.js
syllabus.md
tap_hold.md Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 4 years ago
translating.md
uart_driver.md
understanding_qmk.md Some docs improvements (#15845) 4 years ago
unit_testing.md
usb_nkro.txt
ws2812_driver.md

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.