qmk_firmware/docs
Ryan 3ba88f7798
LED drivers: update PWM register defines for `g_<driver>_leds` (#23052)
2024-02-12 02:19:45 +00:00
..
ChangeLog
gitbook/images
internals
ja I2C driver cleanup (#21273) 2024-01-17 14:05:38 +01:00
zh-cn
.nojekyll
CNAME
README.md
_langs.md
_summary.md
adc_driver.md
apa102_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
audio_driver.md [Audio] Enable Complementary output for PWM Hardware driver (#22726) 2023-12-21 19:38:59 -08:00
breaking_changes.md
breaking_changes_history.md
breaking_changes_instructions.md
chibios_upgrade_instructions.md
cli.md Give definition of 'CLI' for new users (#22647) 2023-12-13 02:25:55 +00:00
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 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) 2024-01-09 22:24:53 +11:00
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
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
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_eeprom.md
feature_encoders.md [Doc] Use number indexes for encoder code example (#22980) 2024-01-29 19:28:23 +00:00
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 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) 2024-02-12 02:19:45 +00:00
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md
feature_os_detection.md
feature_pointing_device.md Cirque reachable calibration aide (#22803) 2024-01-13 00:28:09 -08:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md add pywinusb lib to list of example libs for HID (#22747) 2024-01-09 22:13:51 +11:00
feature_repeat_key.md
feature_rgb_matrix.md LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) 2024-02-12 02:19:45 +00:00
feature_rgblight.md
feature_secure.md
feature_send_string.md
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) 2024-01-09 22:24:53 +11:00
feature_st7565.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md Align location of tap dance keycode (#22742) 2023-12-24 06:52:41 +00:00
feature_tri_layer.md
feature_unicode.md
feature_userspace.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
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 I2C driver cleanup (#21273) 2024-01-17 14:05:38 +01:00
index.html
isp_flashing_guide.md
keycodes.md
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keymap.md Update keymap.md (#22834) 2024-01-06 12:06:14 +11:00
mod_tap.md
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md
newbs_external_userspace.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_blackpill_f4x1.md
platformdev_chibios_earlyinit.md
platformdev_proton_c.md
platformdev_rp2040.md
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md
power.txt
pr_checklist.md [docs] - reword PR checklist for vendor keymaps/userspace changes (#22725) 2023-12-21 12:30:55 +00:00
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 redundant audio eeconfig init (#22736) 2023-12-24 06:52:58 +00:00
reference_keymap_extras.md Add Canadian French input locale (#21456) 2024-01-09 22:11:59 +11:00
serial_driver.md
spi_driver.md
squeezing_avr.md
support.md
support_deprecation_policy.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.