History

QMK Bot de5f6539f8 Merge remote-tracking branch 'origin/master' into develop		2023-07-09 10:07:34 +00:00
..
ChangeLog	`develop` 2023q2 changelog (#21049 )	2023-05-29 06:02:11 +10:00
gitbook/images	…
internals	…
ja	Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272 )	2023-06-21 08:41:49 +10:00
zh-cn	[Core] Add Repeat Key ("repeat last key") as a core feature. (#19700 )	2023-05-20 22:35:06 +10:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	Update "Most Recent ChangeLog" (#21071 )	2023-05-28 21:36:46 +01:00
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	Branch point for 2023q3 Breaking Change.	2023-05-29 06:20:09 +10:00
breaking_changes_history.md	`develop` 2023q2 changelog (#21049 )	2023-05-29 06:02:11 +10:00
breaking_changes_instructions.md	`develop` 2023q2 changelog (#21049 )	2023-05-29 06:02:11 +10:00
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	`qmk find`: usability improvements (#20440 )	2023-05-20 22:14:43 +10:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	…
coding_conventions_c.md	[Docs] Code markdown amendment (#21323 )	2023-06-20 20:58:13 -06:00
coding_conventions_python.md	…
compatible_microcontrollers.md	STM32H723 support (#21352 )	2023-06-28 13:07:14 +10:00
config_options.md	Keymap introspection for combos. (#19670 )	2023-05-15 22:27:37 +10: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	Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272 )	2023-06-21 08:41:49 +10:00
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	Update code example to match description (#20528 )	2023-04-23 12:56:45 -06:00
feature_audio.md	…
feature_auto_shift.md	Adds a way to separate tab from AUTO_SHIFT_SPECIAL. (#20996 )	2023-07-07 21:52:24 +10:00
feature_autocorrect.md	[Enhancement] More info on `apply_autocorrect` (#21056 )	2023-07-08 00:13:15 +10:00
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_caps_word.md	…
feature_combo.md	Keymap introspection for combos. (#19670 )	2023-05-15 22:27:37 +10:00
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	…
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	Fix anchor IDs for some API references (#21345 )	2023-06-24 17:44:50 +10:00
feature_joystick.md	…
feature_key_lock.md	…
feature_key_overrides.md	[Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992 )	2023-07-08 00:18:02 +10:00
feature_layers.md	Changed interverts to inverts (#21270 )	2023-07-03 17:01:10 +01:00
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	…
feature_led_matrix.md	Remove use of __flash within LED drivers (#21343 )	2023-06-23 22:50:31 +01:00
feature_macros.md	…
feature_midi.md	…
feature_mouse_keys.md	Refactor kinetic mouse key feature (#21164 )	2023-07-08 00:26:06 +10:00
feature_oled_driver.md	OLED Driver improvements (#20331 )	2023-05-10 14:04:53 -07:00
feature_os_detection.md	…
feature_pointing_device.md	Make Pointing Device Auto Layer more configurable (#20061 )	2023-05-06 06:38:45 -07:00
feature_programmable_button.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_repeat_key.md	[Core] Add Repeat Key ("repeat last key") as a core feature. (#19700 )	2023-05-20 22:35:06 +10:00
feature_rgb_matrix.md	Remove use of __flash within LED drivers (#21343 )	2023-06-23 22:50:31 +01:00
feature_rgblight.md	Move `RGBLIGHT_LED_MAP` to data driven (#21095 )	2023-06-14 22:01:13 +10:00
feature_secure.md	…
feature_send_string.md	Fix anchor IDs for some API references (#21345 )	2023-06-24 17:44:50 +10:00
feature_sequencer.md	…
feature_space_cadet.md	Use wayback machine for unreachable site (#20987 )	2023-05-21 17:44:06 +01:00
feature_split_keyboard.md	…
feature_st7565.md	…
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	…
feature_tri_layer.md	…
feature_unicode.md	Unicodemap keycodes rename (#21092 )	2023-06-01 17:25:08 +01:00
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flash_driver.md	…
flashing.md	feat, docs: WB32 flashing (#21217 )	2023-07-08 00:48:45 +10:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Unicodemap keycodes rename (#21092 )	2023-06-01 17:25:08 +01:00
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	Fix anchor IDs for some API references (#21345 )	2023-06-24 17:44:50 +10:00
index.html	…
isp_flashing_guide.md	…
keycodes.md	Unicodemap keycodes rename (#21092 )	2023-06-01 17:25:08 +01:00
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	Update newbs docs with some rp2040 stuff (#21186 )	2023-06-10 15:56:43 +01:00
newbs_building_firmware_workflow.md	[Docs] Highlight keymap name entry (#21138 )	2023-06-05 23:17:39 -06:00
newbs_flashing.md	Update newbs docs with some rp2040 stuff (#21186 )	2023-06-10 15:56:43 +01:00
newbs_getting_started.md	Add an emphasis on QMK MSYS terminal (#21168 )	2023-06-08 10:10:30 +01:00
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	Far better VSCode intellisense support using clangd. (#20382 )	2023-05-14 15:32:34 +10:00
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	clarify what the heck pristine means for reasons (#20950 )	2023-07-07 22:07:02 +10:00
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	[Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290 )	2023-06-19 19:55:27 -06:00
quantum_painter.md	[Docs] Fix listed defaults in quantum painter docs (#21429 )	2023-07-03 00:08:45 -07:00
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	…
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	Fix anchor IDs for some API references (#21345 )	2023-06-24 17:44:50 +10:00
squeezing_avr.md	[Docs] Squeeze AVR with simplified magic config functions (#21477 )	2023-07-09 20:05:45 +10:00
support.md	…
support_deprecation_policy.md	…
sw.js	…
syllabus.md	…
tap_hold.md	[Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992 )	2023-07-08 00:18:02 +10:00
translating.md	…
uart_driver.md	Fix anchor IDs for some API references (#21345 )	2023-06-24 17:44:50 +10:00
understanding_qmk.md	Move `pre_process_record_kb()` before `process_combo()` (#20969 )	2023-05-20 22:15:55 +10:00
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.

Help people out on our forums and chat rooms:
- /r/olkb
- Discord Server
Contribute to our documentation by clicking "Edit This Page" at the bottom
Translate our documentation into your language
Report a bug
Open a Pull Request