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.
Joel Challis f587a0c548
Align sequencer keycodes (#19875)
3 years ago
..
ChangeLog Merge remote-tracking branch 'origin/master' into develop 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 [Core] Tri Layer Keys (#19795) 3 years ago
adc_driver.md Add analog support for RP2040 (#19453) 3 years ago
api_development_environment.md
api_development_overview.md
api_docs.md 2022 Nov 26 changelog. (#19164) 3 years ago
api_overview.md
arm_debugging.md
audio_driver.md [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 3 years ago
breaking_changes.md Minor cleanup to breaking/checklist docs. (#19596) 3 years ago
breaking_changes_history.md Stub next develop dates 3 years ago
breaking_changes_instructions.md
chibios_upgrade_instructions.md Add `qmk mass-compile`, which intends to supercede `qmk multibuild` whilst providing support for filtering as per data-driven definitions. (#18971) 3 years ago
cli.md
cli_commands.md docs: some typos (#18582) 3 years ago
cli_configuration.md
cli_development.md docs: some typos (#18582) 3 years ago
cli_tab_complete.md
coding_conventions_c.md docs: some typos (#18582) 3 years ago
coding_conventions_python.md docs: some typos (#18582) 3 years ago
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 Remove deprecated Quantum keycodes (#19712) 3 years ago
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md Minor cleanup to breaking/checklist docs. (#19596) 3 years ago
custom_matrix.md Remove matrix_init_quantum/matrix_scan_quantum (#19806) 3 years ago
custom_quantum_functions.md
data_driven_config.md Format DD mappings and schemas (#18924) 3 years ago
documentation_best_practices.md
documentation_templates.md [Docs] Touch up documentation templates & porting keyboard docs (#19573) 3 years ago
driver_installation_zadig.md
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md Remove legacy Debug keycode (#18769) 3 years ago
faq_general.md
faq_keymap.md
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md Align audio keycode names (#18962) 3 years ago
feature_auto_shift.md Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 3 years ago
feature_autocorrect.md Clean up `qmk generate-autocorrect-data` (#19710) 3 years ago
feature_backlight.md Reworked backlight keycodes. (#18961) 3 years ago
feature_bluetooth.md Normalise output selection (Bluetooth) keycodes (#19004) 3 years ago
feature_bootmagic.md
feature_caps_word.md Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) 3 years ago
feature_combo.md Add combo hook to allow per layer combo reference layers. (#16699) 3 years ago
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 Digitizer feature improvements (#19034) 3 years ago
feature_dip_switch.md
feature_dynamic_macros.md Normalise Dynamic Macro keycodes (#18939) 3 years ago
feature_eeprom.md Remove rgblight_list.h (#18878) 3 years ago
feature_encoders.md Elaborate on keyboard level encoder functionality (#19839) 3 years ago
feature_grave_esc.md
feature_haptic_feedback.md Align haptic feedback keycode names (#18964) 3 years ago
feature_hd44780.md
feature_joystick.md [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) 3 years ago
feature_key_lock.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_key_overrides.md Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` (#18843) 3 years ago
feature_layers.md Update documentation for LM(layer, mod) (#19284) 3 years ago
feature_layouts.md
feature_leader_key.md Refactor Leader key feature (#19632) 3 years ago
feature_led_indicators.md Remove deprecated led_set_kb (#19273) 3 years ago
feature_led_matrix.md docs: Fix IS31FL3743A driver name (#19518) 3 years ago
feature_macros.md Macro keycode name refactoring (#18958) 3 years ago
feature_midi.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_mouse_keys.md add "inertia" mode for mouse keys (#18774) 3 years ago
feature_oled_driver.md Update OLED doc (#19213) 3 years ago
feature_os_detection.md Detect host OS based on USB fingerprint (#18463) 3 years ago
feature_pointing_device.md Add `*_RIGHT` configuration for PMW33XX driver (#19243) 3 years ago
feature_programmable_button.md Normalise Joystick and Programmable Button keycodes (#18832) 3 years ago
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Use consistent highlight format (#19619) 3 years ago
feature_rgblight.md Fix description for selectively disabling animations (#19374) 3 years ago
feature_secure.md Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 years ago
feature_send_string.md
feature_sequencer.md Align sequencer keycodes (#19875) 3 years ago
feature_space_cadet.md Normalise Space Cadet keycodes (#18864) 3 years ago
feature_split_keyboard.md Merge remote-tracking branch 'origin/master' into develop 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 Tap Dance: remove `qk_` prefix (#19313) 3 years ago
feature_tri_layer.md [Core] Tri Layer Keys (#19795) 3 years ago
feature_unicode.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_userspace.md
feature_velocikey.md Deprecate `VLK_TOG` for `VK_TOGG` (#18807) 3 years ago
feature_wpm.md
flash_driver.md
flashing.md Add f303 to tinyuf2 bootloader support (#19620) 3 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 Fix functions with empty params (#19647) 3 years ago
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
isp_flashing_guide.md
keycodes.md Normalise Swap Hands keycodes (#19720) 3 years ago
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keymap.md [Docs] Change defines to enums in examples (#19793) 3 years ago
mod_tap.md
newbs.md
newbs_building_firmware.md Align new-keymap with new-keyboard (#19229) 3 years ago
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.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 [Docs] Resynchronizing Your Branch including submodules (#19268) 3 years ago
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
one_shot_keys.md fix typo (#19189) 3 years ago
other_eclipse.md
other_vscode.md [Doc]Remove depracted extension links in vscode guide (#19842) 3 years ago
platformdev_blackpill_f4x1.md Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 3 years ago
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] Touch up documentation templates & porting keyboard docs (#19573) 3 years ago
power.txt
pr_checklist.md Minor cleanup to breaking/checklist docs. (#19596) 3 years ago
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
quantum_painter.md Add RGB565 and RGB888 color support to Quantum Painter (#19382) 3 years ago
quantum_painter_lvgl.md Fix functions with empty params (#19647) 3 years ago
quantum_painter_qff.md
quantum_painter_qgf.md
quantum_painter_rle.md
redirects.json
ref_functions.md Remove legacy EEPROM clear keycodes (#18782) 3 years ago
reference_configurator_support.md
reference_glossary.md
reference_info_json.md Rework input_pressed_state docs (#19267) 3 years ago
reference_keymap_extras.md
serial_driver.md Fix serial_driver.md list item numbering (#19819) 3 years ago
spi_driver.md
squeezing_avr.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 years ago
support.md
sw.js
syllabus.md
tap_hold.md Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 3 years ago
translating.md
uart_driver.md
understanding_qmk.md Update understanding_qmk.md (#19664) 3 years ago
unit_testing.md
usb_nkro.txt
ws2812_driver.md [Core] Allow custom timings for WS2812 PIO driver (#18006) 3 years ago

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.