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.
Ryan d5cb7de5e4
Change USBasp and bootloadHID bootloaders to lowercase (#14354)
4 years ago
..
ChangeLog Bootmagic lite docs clarity. (#14204) 4 years ago
de
es
fr-fr
gitbook/images
he-il
ja move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 4 years ago
ko-kr
pt-br
ru-ru
zh-cn
.nojekyll
CNAME
README.md
_langs.md
_summary.md
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 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 4 years ago
breaking_changes_history.md 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 4 years ago
breaking_changes_instructions.md
chibios_upgrade_instructions.md
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 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
configurator_architecture.md
configurator_default_keymaps.md
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 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md [Docs] Update path to keycode.h (#14263) 4 years ago
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_combo.md
feature_command.md
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_encoders.md
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md Bugfix for Joystick and JSON schema (#14295) 4 years ago
feature_key_lock.md
feature_key_overrides.md Documentation: Fix links in key overrides (#14228) 4 years ago
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md
feature_led_matrix.md Align rgb/led matrix docs with current behaviour (#14367) 4 years ago
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md [Core] Add `is_oled_scrolling` (#14305) 4 years ago
feature_pointing_device.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Align rgb/led matrix docs with current behaviour (#14367) 4 years ago
feature_rgblight.md
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Make solo half of split keyboards (more) usable. (#13523) 4 years ago
feature_st7565.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md Highlight keycode (#14317) 4 years ago
feature_wpm.md
flashing.md Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
flashing_bootloadhid.md Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md Change USBasp and bootloadHID bootloaders to lowercase (#14354) 4 years ago
getting_started_vagrant.md move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 4 years ago
hand_wire.md
hardware_avr.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
internals_defines.md
internals_gpio_control.md
internals_input_callback_reg.md
internals_midi_device.md
internals_midi_device_setup_process.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md
keycodes.md
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keymap.md
mod_tap.md
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
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
platformdev_chibios_earlyinit.md
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md
proton_c_conversion.md
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md Fix Space Cadet md link (#14300) 4 years ago
reference_info_json.md
reference_keymap_extras.md
serial_driver.md Make solo half of split keyboards (more) usable. (#13523) 4 years ago
spi_driver.md
support.md
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.