History

QMK Bot 59862d30d0 Merge remote-tracking branch 'origin/master' into develop		2021-06-07 06:53:52 +00:00
..
ChangeLog	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
de	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
es	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
fr-fr	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
gitbook/images	…
he-il	…
ja	Update Japanese document (#10670 )	2021-06-06 03:36:48 +09:00
ko-kr	…
pt-br	…
ru-ru	…
zh-cn	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	[Docs] added basic midi documention of common features (#13113 )	2021-06-06 23:53:20 -07:00
adc_driver.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	Update ChibiOS, ChibiOS-Contrib. (#13056 )	2021-06-01 08:11:50 +10:00
breaking_changes_history.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	Update ChibiOS, ChibiOS-Contrib. (#13056 )	2021-06-01 08:11:50 +10:00
cli.md	…
cli_commands.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	Add support for tab completion (#12411 )	2021-04-14 19:00:22 -07:00
coding_conventions_c.md	…
coding_conventions_python.md	…
compatible_microcontrollers.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
config_options.md	[Docs] Fix typos in audio config in main config page (#12928 )	2021-05-21 22:42:26 -07:00
configurator_default_keymaps.md	…
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	…
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665 )	2021-03-03 13:31:41 -08:00
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	…
feature_audio.md	[Docs] added basic midi documention of common features (#13113 )	2021-06-06 23:53:20 -07:00
feature_auto_shift.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_backlight.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_grave_esc.md	…
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_layers.md	Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306 )	2021-03-25 22:44:28 +11:00
feature_layouts.md	…
feature_leader_key.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_led_indicators.md	…
feature_led_matrix.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_macros.md	…
feature_midi.md	[Docs] added basic midi documention of common features (#13113 )	2021-06-06 23:53:20 -07:00
feature_mouse_keys.md	…
feature_oled_driver.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_rgblight.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Add EE_HANDS documentation command example (#12730 )	2021-05-20 19:03:56 +09:00
feature_stenography.md	…
feature_swap_hands.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_tap_dance.md	More Tap Dance docs improvements (#12358 )	2021-03-24 19:46:22 +00:00
feature_terminal.md	Remove build option firmware size impacts (#6947 )	2019-10-18 18:14:49 -07:00
feature_thermal_printer.md	…
feature_unicode.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
flashing.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
flashing_bootloadhid.md	…
fuse.txt	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Documentation update (#12484 )	2021-04-11 12:49:12 +02: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	…
internals_defines.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
internals_gpio_control.md	…
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	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306 )	2021-03-25 22:44:28 +11:00
newbs.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	A few small typo fixes in docs (#12524 )	2021-04-11 12:50:45 +02:00
newbs_getting_started.md	Update FreeBSD install method (#12815 )	2021-05-07 19:22:05 +02: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	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
other_eclipse.md	eclipse: recommend changing the default project make target (#12447 )	2021-04-19 02:20:17 -07:00
other_vscode.md	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	Add additional info to PR Checklist (#12630 )	2021-04-20 20:12:57 +02:00
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	…
reference_keymap_extras.md	…
serial_driver.md	2021 May 29 Breaking Changes Update (#13034 )	2021-05-29 14:38:50 -07:00
spi_driver.md	…
support.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	Fix up WS2812 SPI driver on F072. (#13022 )	2021-06-03 09:48:16 +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