History

skullY 1b7fa46f8e Add dark mode support		2020-03-05 16:00:10 -08:00
..
ChangeLog	2020 February 29 Breaking Changes Update (#8064 )	2020-02-29 11:59:30 -08:00
de	…
es	remove unused docs	2020-03-05 16:00:10 -08:00
fr-fr	…
gitbook/images	…
he-il	remove unused docs	2020-03-05 16:00:10 -08:00
ja	[Docs] translated 'feature_tap_dance.md' to japanese. (#8137 )	2020-02-29 20:22:15 -08:00
pt-br	…
ru-ru	remove unused docs	2020-03-05 16:00:10 -08:00
zh-cn	[Docs] doc update zh-cn (#8147 )	2020-02-11 10:05:23 -08:00
.nojekyll	…
CNAME	…
README.md	rework the index page	2020-03-05 16:00:10 -08:00
_langs.md	…
_summary.md	_summary.md: move Auto Shift page to Software Features category	2020-03-05 16:00:10 -08:00
adc_driver.md	…
arm_debugging.md	…
breaking_changes.md	Fix the Breaking Changes doc again	2020-02-29 20:46:48 -08:00
breaking_changes_instructions.md	suggestions by skullydazed	2020-01-25 18:15:07 -08:00
cli.md	remove some unnecessary external links	2020-03-05 16:00:10 -08:00
cli_configuration.md	…
cli_development.md	…
coding_conventions_c.md	…
coding_conventions_python.md	Add a note explaining how to run tests	2020-01-14 07:52:14 -08:00
compatible_microcontrollers.md	…
config_options.md	New feature: PERMISSIVE_HOLD_PER_KEY (#7994 )	2020-02-25 13:25:52 -05:00
contributing.md	…
custom_matrix.md	Add docs for 'CUSTOM_MATRIX = lite' (#7906 )	2020-01-18 12:56:33 +11:00
custom_quantum_functions.md	Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838 )	2020-01-10 02:48:06 -05:00
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
eeprom_driver.md	Add customisable EEPROM driver selection (#7274 )	2020-01-24 12:45:58 +11:00
faq_build.md	[Docs] Update macOS related issues in docs (#7744 )	2019-12-31 14:33:54 +00:00
faq_debug.md	…
faq_general.md	Remove unanswered/unnecessary FAQ item	2019-10-07 15:43:42 -07:00
faq_keymap.md	…
feature_advanced_keycodes.md	New feature: PERMISSIVE_HOLD_PER_KEY (#7994 )	2020-02-25 13:25:52 -05:00
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	2020 February 29 Breaking Changes Update (#8064 )	2020-02-29 11:59:30 -08: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	2020 February 29 Breaking Changes Update (#8064 )	2020-02-29 11:59:30 -08:00
feature_grave_esc.md	Document an annoyance with Grave Escape and macOS Terminal (#5483 )	2019-03-24 17:11:26 -07:00
feature_haptic_feedback.md	…
feature_hd44780.md	…
feature_key_lock.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_matrix.md	…
feature_macros.md	Add support for delays in send_string. (#8244 )	2020-02-27 20:38:19 +11:00
feature_mouse_keys.md	…
feature_oled_driver.md	Fix out of bound OLED font access (#8145 )	2020-02-11 21:38:20 +00:00
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rgb_matrix.md	Configuration values for starting HSV and speed (#7740 )	2020-01-18 20:11:33 +00:00
feature_rgblight.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	Reduce SPLIT_USB_TIMEOUT by 500ms (#7637 )	2020-02-04 19:37:04 -08:00
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	…
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	`send_unicode_string()`: Add support for code points > 0xFFFF (#8236 )	2020-02-25 12:54:51 +11:00
feature_userspace.md	…
feature_velocikey.md	…
flashing.md	…
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_getting_help.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Add docs for 'CUSTOM_MATRIX = lite' (#7906 )	2020-01-18 12:56:33 +11:00
getting_started_vagrant.md	…
hand_wire.md	…
hardware_avr.md	…
hardware_drivers.md	Add customisable EEPROM driver selection (#7274 )	2020-01-24 12:45:58 +11:00
hardware_keyboard_guidelines.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	Add dark mode support	2020-03-05 16:00:10 -08:00
internals_defines.md	…
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	[Docs] Update ISP Flashing guide (#8149 )	2020-03-01 22:29:26 -08:00
keycodes.md	remove some unnecessary external links	2020-03-05 16:00:10 -08:00
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
newbs.md	Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633 )	2019-12-14 18:16:31 +00:00
newbs_building_firmware.md	Fixed a small typo (#7743 )	2020-01-03 08:06:46 +11:00
newbs_building_firmware_configurator.md	clean up links to keycode references in newbs_building_firmware_configurator.md	2020-03-05 16:00:10 -08:00
newbs_flashing.md	…
newbs_getting_started.md	more wip	2020-03-05 16:00:10 -08:00
newbs_git_best_practices.md	[Docs] Restructure of Git Best Practices doc (#7231 )	2019-12-02 18:47:02 -08:00
newbs_git_resolving_merge_conflicts.md	…
newbs_git_resynchronize_a_branch.md	[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728 )	2019-12-27 14:31:23 -08:00
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902 )	2018-10-18 15:12:11 -07:00
newbs_testing_debugging.md	[Docs] Replace Switch Hitter link with Wayback Machine link (#7009 )	2019-10-15 23:21:05 +01:00
other_eclipse.md	…
other_vscode.md	…
power.txt	…
proton_c_conversion.md	…
qmk.css	…
quantum_keycodes.md	Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093 )	2020-02-07 15:54:14 +11:00
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	…
sidebar.css	…
support.md	remove some unnecessary external links	2020-03-05 16:00:10 -08:00
sw.js	…
translating.md	…
understanding_qmk.md	…
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	PWM DMA based RGB Underglow for STM32 (#7928 )	2020-03-01 13:05:56 +11: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. Early on the community was keyboard focused, but has now grown to include mice and MIDI devices as well. The community maintains QMK Firmware, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation.

Get Started

Totally new to QMK? There are two ways to get started:

Basic: QMK Configurator
- Just select your keyboard from the dropdown and program your keyboard.
- We have an introductory video you can watch.
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.