History

QMK Bot a76a6580f8 Merge remote-tracking branch 'origin/master' into develop		2024-05-19 04:44:03 +00:00
..
ChangeLog	MechKeys ACR60 Layout Updates (#23309 )	2024-04-29 20:04:04 -07:00
gitbook/images	…
internals	…
ja	Fix WAIT_FOR_USB handling (#23598 )	2024-04-24 19:33:52 +01:00
zh-cn	Move velocikey to within rgblight (#22123 )	2023-09-25 17:48:10 +01:00
.nojekyll	Use docsfy to replace gitbook	2018-05-07 22:46:26 -07:00
CNAME	…
README.md	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
__capabilities.md	Add embed to docs capabilities (#23698 )	2024-05-12 03:26:11 +10:00
__capabilities_inc.md	Add embed to docs capabilities (#23698 )	2024-05-12 03:26:11 +10:00
_langs.md	…
_summary.md	2024q1 `develop` changelog. (#23150 )	2024-02-28 21:39:19 +11:00
adc_driver.md	Generalise ADC driver source inclusion (#22448 )	2023-11-12 22:30:27 +00:00
apa102_driver.md	Update WS2812 docs and add APA102 docs (#22106 )	2023-09-25 14:18:40 +10:00
api_development_environment.md	Add API documentation	2020-03-05 16:00:10 -08:00
api_development_overview.md	Add API documentation	2020-03-05 16:00:10 -08:00
api_docs.md	2022 Nov 26 changelog. (#19164 )	2022-11-28 07:33:55 +11:00
api_overview.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
arm_debugging.md	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
audio_driver.md	[Audio] Enable Complementary output for PWM Hardware driver (#22726 )	2023-12-21 19:38:59 -08:00
breaking_changes.md	2024q1 `develop` changelog. (#23150 )	2024-02-28 21:39:19 +11:00
breaking_changes_history.md	2024q1 `develop` changelog. (#23150 )	2024-02-28 21:39:19 +11:00
breaking_changes_instructions.md	`develop` 2023q2 changelog (#21049 )	2023-05-29 06:02:11 +10:00
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	Merge remote-tracking branch 'origin/master' into develop	2024-05-07 11:52:16 +00:00
cli_configuration.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
cli_development.md	…
cli_tab_complete.md	Add Zsh note for tab complete (#17226 )	2022-07-02 21:59:59 +10:00
coding_conventions_c.md	[Docs] Code markdown amendment (#21323 )	2023-06-20 20:58:13 -06:00
coding_conventions_python.md	Fix minimum python version references (#22191 )	2023-10-04 01:19:04 +01:00
compatible_microcontrollers.md	…
config_options.md	Rename `RGBW` define to `WS2812_RGBW` (#23585 )	2024-04-28 00:36:54 +10:00
configurator_architecture.md	Architecture documentation for Configurator and API (#13935 )	2021-08-10 07:47:53 -07:00
configurator_default_keymaps.md	Reallocate SAFE_RANGE (#19909 )	2023-02-23 09:49:07 +11:00
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	update the Chinese translation based on the latest English version (#14924 )	2022-01-18 18:24:02 +00:00
configurator_troubleshooting.md	Polish Configurator section	2020-03-05 16:00:10 -08:00
contributing.md	Documentation regarding user code removal/acceptance (#22507 )	2023-12-04 00:57:42 +00:00
custom_matrix.md	Remove matrix_init_quantum/matrix_scan_quantum (#19806 )	2023-02-11 03:47:17 +00:00
custom_quantum_functions.md	Update naming convention for GPIO control macros (#23085 )	2024-02-17 00:18:26 +11:00
data_driven_config.md	Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272 )	2023-06-21 08:41:49 +10:00
documentation_best_practices.md	[Docs] fix file path (#9540 )	2020-06-25 15:58:36 +10:00
documentation_templates.md	[Docs] Touch up documentation templates & porting keyboard docs (#19573 )	2023-01-13 02:58:38 -08:00
driver_installation_zadig.md	Update Atmel DFU driver assignments for dfu-programmer 1.x (#23165 )	2024-02-28 21:03:43 +11:00
easy_maker.md	update the Chinese translation based on the latest English version (#14924 )	2022-01-18 18:24:02 +00:00
eeprom_driver.md	Consolidate some EEPROM Driver configuration (#22321 )	2023-10-23 00:37:27 +01:00
faq_build.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
faq_debug.md	…
faq_general.md	…
faq_keymap.md	Keymap FAQ updates (#17130 )	2022-05-18 04:48:59 +10:00
faq_misc.md	[Docs] RESET -> QK_BOOT (#18365 )	2022-09-15 01:03:55 +01:00
feature_advanced_keycodes.md	…
feature_audio.md	[Audio] Add support for audio shutdown pin (#22731 )	2024-03-06 22:02:37 +11:00
feature_auto_shift.md	…
feature_autocorrect.md	…
feature_backlight.md	Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480 )	2023-11-22 11:41:19 +11:00
feature_bluetooth.md	…
feature_bootmagic.md	Removal of bootmagic lite terminology (#22979 )	2024-02-17 12:27:34 +00:00
feature_caps_word.md	…
feature_combo.md	[Doc] Reference advance keycodes in combos (#23666 )	2024-05-18 21:41:03 -07:00
feature_command.md	…
feature_converters.md	Add Imera converter (#22419 )	2023-11-28 17:53:47 +11:00
feature_debounce_type.md	…
feature_digitizer.md	Digitizer feature improvements (#19034 )	2022-11-12 23:28:11 +00:00
feature_dip_switch.md	Keymap introspection for Dip Switches (#22543 )	2023-12-11 23:06:18 +00:00
feature_dynamic_macros.md	Add direction to dynamic_macro_record_start_user (#19689 )	2023-04-03 13:01:07 +10:00
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	haptic: further naming cleanups (#21682 )	2023-08-04 01:16:16 +01:00
feature_hd44780.md	…
feature_joystick.md	Fix joystick initialization (#22953 )	2024-02-17 01:14:46 +11:00
feature_key_lock.md	…
feature_key_overrides.md	Fix typos: key-modifer→key-modifier and interacton→interaction (#22464 )	2023-11-13 20:55:45 +00:00
feature_layers.md	…
feature_layouts.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
feature_leader_key.md	…
feature_led_indicators.md	Update naming convention for GPIO control macros (#23085 )	2024-02-17 00:18:26 +11:00
feature_led_matrix.md	Add new set of keycodes for LED Matrix (#23432 )	2024-04-11 14:14:02 +10:00
feature_macros.md	Add latam spanish headers (#22542 )	2023-12-04 00:13:27 +00:00
feature_midi.md	…
feature_mouse_keys.md	Add MOUSEKEY_WHEEL_DELTA documentation (#21493 )	2023-07-10 10:57:08 -07:00
feature_oled_driver.md	[Doc]: Correct Markdown syntax errors. (#22511 )	2023-11-29 02:48:47 +00:00
feature_os_detection.md	[Core] Add OS detection callbacks (#21777 )	2024-02-17 01:19:02 +11:00
feature_pointing_device.md	Add utility functions for Pointing Device Auto Mouse feature (#23144 )	2024-03-10 05:34:41 +00:00
feature_programmable_button.md	…
feature_ps2_mouse.md	Document the RP2040-specific PS/2 implementation (#22079 )	2023-09-25 13:00:13 +10:00
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	[Core] Add Repeat Key ("repeat last key") as a core feature. (#19700 )	2023-05-20 22:35:06 +10:00
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	Rename `RGBW` define to `WS2812_RGBW` (#23585 )	2024-04-28 00:36:54 +10:00
feature_secure.md	Deprecate `SECURE_` keycodes for `QK_SECURE_` (#18847 )	2022-10-25 22:59:17 +01:00
feature_send_string.md	…
feature_sequencer.md	Remove deprecated quantum keycodes (#23407 )	2024-04-04 15:16:27 +01:00
feature_space_cadet.md	Use wayback machine for unreachable site (#20987 )	2023-05-21 17:44:06 +01:00
feature_split_keyboard.md	Oneshot locked mods split transaction (#23434 )	2024-04-08 12:55:42 -06:00
feature_st7565.md	ST7565 invert (#13237 )	2021-06-19 18:51:35 +10:00
feature_stenography.md	Remove requirement for `keymap_steno.h` include in keymaps (#22423 )	2023-11-12 18:25:46 +11:00
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	Update feature_tri_layer.md - typo (#23275 )	2024-03-14 14:28:54 +11:00
feature_unicode.md	Fix old usage of UNICODE_MODE_MAC (#22238 )	2023-10-09 23:16:54 +01:00
feature_userspace.md	Documentation regarding user code removal/acceptance (#22507 )	2023-12-04 00:57:42 +00:00
feature_wpm.md	Fix typo in `feature_wpm.md` title (#20464 )	2023-04-16 15:14:08 +01:00
flash_driver.md	Added external spi flash driver. (#15419 )	2022-02-11 20:26:16 +00:00
flashing.md	Add page for capabilties used by docs site. (#23428 )	2024-05-05 11:38:31 +01:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	[Docs] Clean up some code block languages (#14434 )	2021-09-14 13:16:24 +01:00
getting_started_github.md	…
getting_started_introduction.md	Modify wording in 'getting_started_introduction.md' (#23232 )	2024-03-14 19:00:03 -07:00
getting_started_make_guide.md	Unicodemap keycodes rename (#21092 )	2023-06-01 17:25:08 +01:00
gpio_control.md	Update naming convention for GPIO control macros (#23085 )	2024-02-17 00:18:26 +11:00
hand_wire.md	Update hand_wire.md (#23429 )	2024-04-06 16:57:12 -06:00
hardware_drivers.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
hardware_keyboard_guidelines.md	Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570 )	2023-12-12 15:30:08 +11:00
how_a_matrix_works.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
how_keyboards_work.md	docs: reflect systemd's change in language (#17322 )	2022-06-06 23:29:59 +01:00
i2c_driver.md	Update naming convention for GPIO control macros (#23085 )	2024-02-17 00:18:26 +11:00
index.html	…
isp_flashing_guide.md	Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486 )	2023-04-19 19:23:50 +01:00
keycodes.md	Add new set of keycodes for LED Matrix (#23432 )	2024-04-11 14:14:02 +10:00
keycodes_basic.md	…
keycodes_magic.md	Align magic keycodes (#19877 )	2023-02-23 08:14:29 +11:00
keycodes_us_ansi_shifted.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
keymap.md	Update keymap.md (#22834 )	2024-01-06 12:06:14 +11:00
mod_tap.md	…
newbs.md	Add page for capabilties used by docs site. (#23428 )	2024-05-05 11:38:31 +01:00
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_building_firmware_workflow.md	[Doc]: Correct Markdown syntax errors. (#22511 )	2023-11-29 02:48:47 +00:00
newbs_external_userspace.md	QMK Userspace (#22222 )	2023-11-28 07:53:43 +11:00
newbs_flashing.md	Update newbs docs with some rp2040 stuff (#21186 )	2023-06-10 15:56:43 +01:00
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 )	2023-02-11 12:07:51 -07:00
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	[Docs] Refactor code examples (#18003 )	2022-08-12 17:27:24 -07:00
newbs_testing_debugging.md	…
one_shot_keys.md	fix typo (#19189 )	2022-11-29 16:34:20 +00:00
other_eclipse.md	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	2022-02-06 17:36:44 +00:00
other_vscode.md	Add instructions for debugging ARM with VSCode+BMP. (#11217 )	2024-03-08 22:24:11 +11:00
platformdev_blackpill_f4x1.md	…
platformdev_chibios_earlyinit.md	…
platformdev_proton_c.md	Add converter docs (#17593 )	2022-07-08 22:49:16 +01:00
platformdev_rp2040.md	[Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839 )	2024-02-20 11:34:24 +01:00
platformdev_selecting_arm_mcu.md	…
porting_your_keyboard_to_qmk.md	[Docs] Discuss layout macro (#19803 )	2023-03-06 11:24:56 -08:00
power.txt	…
pr_checklist.md	PR Checklist: explain wireless requirements. (#23584 )	2024-04-23 19:38:08 +10:00
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
quantum_painter.md	[Driver] ILI9486 on Quantum Painter (#18521 )	2024-02-17 18:36:05 +11:00
quantum_painter_lvgl.md	Lvgl rate control (#22049 )	2023-09-17 14:25:14 +10:00
quantum_painter_qff.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
quantum_painter_qgf.md	Quantum Painter (#10174 )	2022-04-13 18:00:18 +10:00
quantum_painter_rle.md	…
redirects.json	…
ref_functions.md	Remove legacy EEPROM clear keycodes (#18782 )	2022-10-20 12:20:07 +01:00
reference_configurator_support.md	…
reference_glossary.md	Breaking changes changelog, 2023q3 version (#21848 )	2023-08-29 21:15:21 +10:00
reference_info_json.md	Remove 'split.transport.protocol=serial_usart' (#23668 )	2024-05-10 20:54:44 +10:00
reference_keymap_extras.md	Add MacOS Czech ISO and ANSI keymaps #23346 (#23412 )	2024-04-30 23:53:30 -07:00
serial_driver.md	Update serial_driver.md (#23035 )	2024-03-29 19:04:23 -06:00
spi_driver.md	Dedupe I2C, SPI, UART driver inclusions (#22253 )	2023-10-13 17:25:32 +11:00
squeezing_avr.md	[Doc] Revise squeezing AVR (#23665 )	2024-05-12 00:33:01 +01:00
support.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
support_deprecation_policy.md	Initial deprecation policy documentation. (#19908 )	2023-03-03 14:16:32 +11:00
sw.js	…
syllabus.md	[Docs] Squeezing space out of AVR (#15243 )	2021-11-23 08:14:00 +11:00
tap_hold.md	Fixed non-executable codes in the documentation (#22600 )	2023-12-05 11:06:06 -08:00
translating.md	…
uart_driver.md	[Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839 )	2024-02-20 11:34:24 +01:00
understanding_qmk.md	…
unit_testing.md	Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889 )	2023-09-25 12:45:49 +10:00
usb_nkro.txt	…
ws2812_driver.md	Rename `RGBW` define to `WS2812_RGBW` (#23585 )	2024-04-28 00:36:54 +10:00

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