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.
Albert Y e6e11dfde7
Add disable git safe directory check step (#20040)
3 years ago
..
ChangeLog Add changelog for Leader Key refactor (#19953) 3 years ago
gitbook/images
internals
ja [Doc]Remove depracted extension links in vscode guide (#19842) 3 years ago
zh-cn [Doc]Remove depracted extension links in vscode guide (#19842) 3 years ago
.nojekyll
CNAME
README.md
_langs.md
_summary.md Stub changelog 3 years ago
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
audio_driver.md
breaking_changes.md Update branch names to reflect configurator's new deployment. (#19999) 3 years ago
breaking_changes_history.md Stub changelog 3 years ago
breaking_changes_instructions.md
chibios_upgrade_instructions.md Update branch names to reflect configurator's new deployment. (#19999) 3 years ago
cli.md
cli_commands.md
cli_configuration.md
cli_development.md
cli_tab_complete.md
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md Make Magic handling more consistent in Action Keycode handling (#9126) 3 years ago
configurator_architecture.md
configurator_default_keymaps.md Reallocate SAFE_RANGE (#19909) 3 years ago
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md
feature_autocorrect.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_caps_word.md
feature_combo.md
feature_command.md
feature_converters.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 years ago
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_eeprom.md
feature_encoders.md Elaborate on keyboard level encoder functionality (#19839) 3 years ago
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md
feature_key_lock.md
feature_key_overrides.md
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md
feature_led_matrix.md
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md
feature_os_detection.md
feature_pointing_device.md
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md
feature_rgblight.md
feature_secure.md
feature_send_string.md
feature_sequencer.md Align sequencer keycodes (#19875) 3 years ago
feature_space_cadet.md
feature_split_keyboard.md [Docs] Discuss layout macro (#19803) 3 years ago
feature_st7565.md
feature_stenography.md
feature_swap_hands.md Add swap hands status function (#19831) 3 years ago
feature_tap_dance.md
feature_tri_layer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flash_driver.md
flashing.md
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
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
isp_flashing_guide.md
keycodes.md Align magic keycodes (#19877) 3 years ago
keycodes_basic.md Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 3 years ago
keycodes_magic.md Align magic keycodes (#19877) 3 years ago
keycodes_us_ansi_shifted.md
keymap.md
mod_tap.md
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md Add disable git safe directory check step (#20040) 3 years ago
newbs_flashing.md
newbs_getting_started.md
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
newbs_testing_debugging.md
one_shot_keys.md
other_eclipse.md
other_vscode.md [Doc]Remove depracted extension links in vscode guide (#19842) 3 years ago
platformdev_blackpill_f4x1.md
platformdev_chibios_earlyinit.md
platformdev_proton_c.md
platformdev_rp2040.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 years ago
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md [Docs] Discuss layout macro (#19803) 3 years ago
power.txt
pr_checklist.md Initial deprecation policy documentation. (#19908) 3 years ago
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
quantum_painter.md
quantum_painter_lvgl.md
quantum_painter_qff.md
quantum_painter_qgf.md
quantum_painter_rle.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md Remove `all` from list of animations in `info.json` (#19978) 3 years ago
reference_keymap_extras.md
serial_driver.md
spi_driver.md
squeezing_avr.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 years ago
support.md
support_deprecation_policy.md Initial deprecation policy documentation. (#19908) 3 years ago
sw.js
syllabus.md
tap_hold.md
translating.md
uart_driver.md
understanding_qmk.md
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.