History

Ryan 9e92d8a905 Make note of upper limit for `UC()` (#15870 )		2022-01-14 14:47:36 +00:00
..
ChangeLog	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
gitbook/images	…
ja	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
zh-cn	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	Remove stale docs translations (#15737 )	2022-01-04 18:11:24 -08:00
_summary.md	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11: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	Fix last merge date (#15327 )	2021-11-28 12:59:48 +11:00
breaking_changes_history.md	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	Add test filter to 'qmk pytest' (#15432 )	2021-12-09 17:42:11 +11:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	…
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	[Docs] Fix Header formatting in compatible mcu doc (#15438 )	2021-12-09 14:49:10 +11:00
config_options.md	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	2021-11-26 07:06:50 +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	Add support for deferred executors. (#14859 )	2021-11-15 18:21:09 +00:00
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	doc/faq_debug: qmk cli can also be used to print debug messages (#15528 )	2021-12-22 06:27:25 -08:00
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059 )	2021-11-25 23:12:14 +11:00
feature_backlight.md	…
feature_bluetooth.md	[Docs] Updated typo on feature_bluetooth.md (#15466 )	2021-12-13 20:55:53 -08:00
feature_bootmagic.md	…
feature_combo.md	Link Macro example for COMBO_ACTION documentation (#15164 )	2021-12-27 14:07:00 +11:00
feature_command.md	…
feature_debounce_type.md	…
feature_digitizer.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	Volume as default encoder documentation example (#15678 )	2022-01-02 00:07:22 -08: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	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	…
feature_led_matrix.md	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
feature_macros.md	Fix keymap.json macro example (#15567 )	2022-01-13 21:55:48 +00:00
feature_midi.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	…
feature_pointing_device.md	[Docs] Add drag scrolling example to Pointing device docs page (#15715 )	2022-01-06 00:30:22 -08:00
feature_programmable_button.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	[Docs] Recommend the use of RGB matrix functions for code (#15744 )	2022-01-11 03:23:28 +11:00
feature_rgblight.md	[Docs] Recommend the use of RGB light functions for code (#15745 )	2022-01-11 03:23:07 +11:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	[Docs] Improve Handedness by EEPROM documentation (#15615 )	2022-01-12 14:05:45 -08:00
feature_st7565.md	…
feature_stenography.md	Merge remote-tracking branch 'origin/master' into develop	2021-11-17 22:31:15 +00:00
feature_swap_hands.md	Document swap-hands tap-toggle feature (#15229 )	2021-11-29 00:23:37 -08:00
feature_tap_dance.md	[Docs] Update feature_tap_dance.md (#14931 )	2022-01-08 19:26:44 -08:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	Reimplements WPM feature to be smaller & precise (#13902 )	2021-11-16 05:40:52 +11:00
flashing.md	Fix RESET not working for keyboards with Kiibohd bootloader (#15430 )	2021-12-07 20:36:39 -08:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Add support for deferred executors. (#14859 )	2021-11-15 18:21:09 +00:00
getting_started_vagrant.md	…
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	Remove stale docs translations (#15737 )	2022-01-04 18:11:24 -08:00
internals_defines.md	…
internals_gpio_control.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
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	Make note of upper limit for `UC()` (#15870 )	2022-01-14 14:47:36 +00:00
keycodes_basic.md	…
keycodes_magic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	…
newbs.md	…
newbs_building_firmware.md	[Docs] Move QMK newbs build environment guide to next section (#15386 )	2022-01-13 02:29:13 +00:00
newbs_building_firmware_configurator.md	…
newbs_flashing.md	[Docs] newbs_flashing.md: add link to build environment section (#15654 )	2022-01-10 16:54:22 -08:00
newbs_getting_started.md	[Docs] Move QMK newbs build environment guide to next section (#15386 )	2022-01-13 02:29:13 +00: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	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	Changelog 2021q4 (#15325 )	2021-11-28 10:41:48 +11:00
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	fix typo (#15569 )	2021-12-24 20:10:12 +00:00
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	…
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	…
squeezing_avr.md	[Docs] fix typo and remove trailing whitespace (#15842 )	2022-01-11 17:07:24 -08:00
support.md	…
sw.js	…
syllabus.md	[Docs] Squeezing space out of AVR (#15243 )	2021-11-23 08:14:00 +11:00
tap_hold.md	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	2021-11-26 07:06:50 +11:00
translating.md	…
uart_driver.md	Update UART driver API (#14839 )	2021-11-13 18:23:14 +00:00
understanding_qmk.md	[Docs] Reorder functions in Understanding QMK (#15357 )	2021-11-30 11:24:21 -08:00
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	Documentation typo fix (#15298 )	2021-11-25 20:13:16 +00: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