Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
ChangeLog
ChangeLog
 
 
gitbook/images
gitbook/images
 
 
internals
internals
 
 
ja
ja
 
 
zh-cn
zh-cn
 
 
.nojekyll
.nojekyll
 
 
CNAME
CNAME
 
 
README.md
README.md
 
 
_langs.md
_langs.md
 
 
_summary.md
_summary.md
 
 
adc_driver.md
adc_driver.md
 
 
api_development_environment.md
api_development_environment.md
 
 
api_development_overview.md
api_development_overview.md
 
 
api_docs.md
api_docs.md
 
 
api_overview.md
api_overview.md
 
 
arm_debugging.md
arm_debugging.md
 
 
audio_driver.md
audio_driver.md
 
 
breaking_changes.md
breaking_changes.md
 
 
breaking_changes_history.md
breaking_changes_history.md
 
 
breaking_changes_instructions.md
breaking_changes_instructions.md
 
 
chibios_upgrade_instructions.md
chibios_upgrade_instructions.md
 
 
cli.md
cli.md
 
 
cli_commands.md
cli_commands.md
 
 
cli_configuration.md
cli_configuration.md
 
 
cli_development.md
cli_development.md
 
 
cli_tab_complete.md
cli_tab_complete.md
 
 
coding_conventions_c.md
coding_conventions_c.md
 
 
coding_conventions_python.md
coding_conventions_python.md
 
 
compatible_microcontrollers.md
compatible_microcontrollers.md
 
 
config_options.md
config_options.md
 
 
configurator_architecture.md
configurator_architecture.md
 
 
configurator_default_keymaps.md
configurator_default_keymaps.md
 
 
configurator_diagram.drawio
configurator_diagram.drawio
 
 
configurator_diagram.svg
configurator_diagram.svg
 
 
configurator_step_by_step.md
configurator_step_by_step.md
 
 
configurator_troubleshooting.md
configurator_troubleshooting.md
 
 
contributing.md
contributing.md
 
 
custom_matrix.md
custom_matrix.md
 
 
custom_quantum_functions.md
custom_quantum_functions.md
 
 
data_driven_config.md
data_driven_config.md
 
 
documentation_best_practices.md
documentation_best_practices.md
 
 
documentation_templates.md
documentation_templates.md
 
 
driver_installation_zadig.md
driver_installation_zadig.md
 
 
easy_maker.md
easy_maker.md
 
 
eeprom_driver.md
eeprom_driver.md
 
 
faq_build.md
faq_build.md
 
 
faq_debug.md
faq_debug.md
 
 
faq_general.md
faq_general.md
 
 
faq_keymap.md
faq_keymap.md
 
 
faq_misc.md
faq_misc.md
 
 
feature_advanced_keycodes.md
feature_advanced_keycodes.md
 
 
feature_audio.md
feature_audio.md
 
 
feature_auto_shift.md
feature_auto_shift.md
 
 
feature_backlight.md
feature_backlight.md
 
 
feature_bluetooth.md
feature_bluetooth.md
 
 
feature_bootmagic.md
feature_bootmagic.md
 
 
feature_caps_word.md
feature_caps_word.md
 
 
feature_combo.md
feature_combo.md
 
 
feature_command.md
feature_command.md
 
 
feature_converters.md
feature_converters.md
 
 
feature_debounce_type.md
feature_debounce_type.md
 
 
feature_digitizer.md
feature_digitizer.md
 
 
feature_dip_switch.md
feature_dip_switch.md
 
 
feature_dynamic_macros.md
feature_dynamic_macros.md
 
 
feature_eeprom.md
feature_eeprom.md
 
 
feature_encoders.md
feature_encoders.md
 
 
feature_grave_esc.md
feature_grave_esc.md
 
 
feature_haptic_feedback.md
feature_haptic_feedback.md
 
 
feature_hd44780.md
feature_hd44780.md
 
 
feature_joystick.md
feature_joystick.md
 
 
feature_key_lock.md
feature_key_lock.md
 
 
feature_key_overrides.md
feature_key_overrides.md
 
 
feature_layers.md
feature_layers.md
 
 
feature_layouts.md
feature_layouts.md
 
 
feature_leader_key.md
feature_leader_key.md
 
 
feature_led_indicators.md
feature_led_indicators.md
 
 
feature_led_matrix.md
feature_led_matrix.md
 
 
feature_macros.md
feature_macros.md
 
 
feature_midi.md
feature_midi.md
 
 
feature_mouse_keys.md
feature_mouse_keys.md
 
 
feature_oled_driver.md
feature_oled_driver.md
 
 
feature_pointing_device.md
feature_pointing_device.md
 
 
feature_programmable_button.md
feature_programmable_button.md
 
 
feature_ps2_mouse.md
feature_ps2_mouse.md
 
 
feature_rawhid.md
feature_rawhid.md
 
 
feature_rgb_matrix.md
feature_rgb_matrix.md
 
 
feature_rgblight.md
feature_rgblight.md
 
 
feature_secure.md
feature_secure.md
 
 
feature_send_string.md
feature_send_string.md
 
 
feature_sequencer.md
feature_sequencer.md
 
 
feature_space_cadet.md
feature_space_cadet.md
 
 
feature_split_keyboard.md
feature_split_keyboard.md
 
 
feature_st7565.md
feature_st7565.md
 
 
feature_stenography.md
feature_stenography.md
 
 
feature_swap_hands.md
feature_swap_hands.md
 
 
feature_tap_dance.md
feature_tap_dance.md
 
 
feature_thermal_printer.md
feature_thermal_printer.md
 
 
feature_unicode.md
feature_unicode.md
 
 
feature_userspace.md
feature_userspace.md
 
 
feature_velocikey.md
feature_velocikey.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.