History

James Young 76189d9a28 link the 2020 Feb 29 Breaking Changes changelog from the summary		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	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
es	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
fr-fr	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
gitbook/images	…
he-il	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
ja	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
pt-br	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
ru-ru	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
zh-cn	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
.nojekyll	…
CNAME	…
README.md	make sure all our redirects are in order	2020-03-05 16:00:10 -08:00
_langs.md	[Docs] add README translation in portuguese (#7016 )	2019-12-10 10:19:12 -08:00
_summary.md	link the 2020 Feb 29 Breaking Changes changelog from the summary	2020-03-05 16:00:10 -08:00
adc_driver.md	Improve support and docs for ADC driver (#7191 )	2019-12-08 12:11:29 +11: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	Add API documentation	2020-03-05 16:00:10 -08:00
api_overview.md	Add API documentation	2020-03-05 16:00:10 -08:00
arm_debugging.md	[Docs] fix docs (#7642 )	2019-12-21 11:00:22 +00:00
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_dev_configuration.md	More sidebar organization	2020-03-05 16:00:10 -08:00
cli_development.md	…
coding_conventions_c.md	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
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	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
configurator_step_by_step.md	Polish Configurator section	2020-03-05 16:00:10 -08:00
configurator_troubleshooting.md	Polish Configurator section	2020-03-05 16:00:10 -08:00
contributing.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
custom_matrix.md	Add docs for 'CUSTOM_MATRIX = lite' (#7906 )	2020-01-18 12:56:33 +11:00
custom_quantum_functions.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
documentation_best_practices.md	…
documentation_templates.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
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	[Docs] Remove some outdated FAQ items (#7607 )	2019-12-11 11:33:09 -08:00
faq_general.md	Rework the newbs guide around the qmk cli	2020-03-05 16:00:10 -08:00
faq_keymap.md	make custom_keycode_names.md a faq entry instead	2020-03-05 16:00:10 -08:00
feature_advanced_keycodes.md	make sure all our redirects are in order	2020-03-05 16:00:10 -08:00
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
feature_bluetooth.md	…
feature_bootmagic.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
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	…
feature_haptic_feedback.md	Minor grammar and filename fixes in docs (#7559 )	2019-12-07 23:19:18 +11:00
feature_hd44780.md	…
feature_key_lock.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
feature_layouts.md	…
feature_leader_key.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
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	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
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	update flashing.md	2020-03-05 16:00:10 -08:00
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_introduction.md	[Docs] update git command and directory name of documents (#7619 )	2019-12-12 20:59:00 -08:00
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	make sure all our redirects are in order	2020-03-05 16:00:10 -08:00
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_a_matrix_works.md	refactor How a Matrix Works doc	2020-03-05 16:00:10 -08:00
how_keyboards_work.md	…
i2c_driver.md	…
index.html	make sure all our redirects are in order	2020-03-05 16:00:10 -08:00
internals_defines.md	…
internals_gpio_control.md	…
internals_input_callback_reg.md	rename api docs to internals	2018-03-26 11:43:37 -07:00
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	keycodes.md: hard-code section link id attributes	2020-03-05 16:00:10 -08:00
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
mod_tap.md	break feature_advanced_keycodes.md up into multiple files	2020-03-05 16:00:10 -08:00
newbs.md	overhaul the newbs guide	2020-03-05 16:00:10 -08:00
newbs_building_firmware.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
newbs_building_firmware_configurator.md	Polish Configurator section	2020-03-05 16:00:10 -08:00
newbs_flashing.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
newbs_getting_started.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
newbs_git_best_practices.md	…
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	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
newbs_learn_more_resources.md	overhaul the newbs guide	2020-03-05 16:00:10 -08:00
newbs_testing_debugging.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
one_shot_keys.md	break feature_advanced_keycodes.md up into multiple files	2020-03-05 16:00:10 -08:00
other_eclipse.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
other_vscode.md	…
power.txt	…
proton_c_conversion.md	Update feature support for Proton C (#7596 )	2019-12-10 18:31:39 -05:00
qmk.css	…
quantum_keycodes.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
redirects.json	…
ref_functions.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
reference_configurator_support.md	Polish Configurator section	2020-03-05 16:00:10 -08:00
reference_glossary.md	…
reference_info_json.md	…
sidebar.css	CSS updates: ul and pre elements	2020-03-05 16:00:10 -08:00
support.md	make sure all our redirects are in order	2020-03-05 16:00:10 -08:00
sw.js	…
tap_hold.md	break feature_advanced_keycodes.md up into multiple files	2020-03-05 16:00:10 -08:00
translating.md	…
understanding_qmk.md	…
unit_testing.md	Add explicit id tags to externally linked headers	2020-03-05 16:00:10 -08:00
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. 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

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.
- There is also an overview document you can read.
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