History

QMK Bot a0e7333915 Merge remote-tracking branch 'origin/master' into develop		2021-01-30 11:01:46 +00:00
..
ChangeLog	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11: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	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
ja	Merge remote-tracking branch 'origin/master' into develop	2021-01-30 11:01:46 +00:00
ko-kr	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
pt-br	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
ru-ru	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
zh-cn	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
.nojekyll	…
CNAME	…
README.md	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
_langs.md	…
_summary.md	UART driver refactor (#11637 )	2021-01-27 17:42:49 +11:00
adc_driver.md	Change analogRead calls to analogReadPin (#9023 )	2020-08-29 14:30:02 -07:00
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +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	…
breaking_changes.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
breaking_changes_instructions.md	2020 May 30 Breaking Changes Update (#9215 )	2020-05-30 13:14:59 -07:00
cli.md	…
cli_commands.md	Improve the compile and flash subcommands (#11334 )	2021-01-16 15:13:04 -08:00
cli_configuration.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
cli_development.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
coding_conventions_c.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
coding_conventions_python.md	…
compatible_microcontrollers.md	Merge remote-tracking branch 'origin/master' into develop	2021-01-30 11:01:46 +00:00
config_options.md	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
configurator_default_keymaps.md	[Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049 )	2020-10-18 03:50:32 +11:00
configurator_step_by_step.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
configurator_troubleshooting.md	…
contributing.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
custom_matrix.md	…
custom_quantum_functions.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
data_driven_config.md	Document how to add data driven configurations (#11502 )	2021-01-10 20:47:58 -08:00
documentation_best_practices.md	[Docs] fix file path (#9540 )	2020-06-25 15:58:36 +10:00
documentation_templates.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
driver_installation_zadig.md	Zadig docs: add APM32 device name (#11356 )	2020-12-30 16:35:06 +00:00
eeprom_driver.md	Add i2c 24LC64 eeprom (#11200 )	2020-12-14 05:50:50 +11: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	Fix typos and reword some sentences in FAQs (#11546 )	2021-01-23 13:41:29 -08:00
faq_general.md	Fix typos and reword some sentences in FAQs (#11546 )	2021-01-23 13:41:29 -08:00
faq_keymap.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
faq_misc.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
feature_advanced_keycodes.md	Doc followup 9942 (#10473 )	2020-10-01 22:19:57 +01:00
feature_audio.md	…
feature_auto_shift.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
feature_backlight.md	Adds AT90USB162 support (#11570 )	2021-01-29 19:53:56 -08:00
feature_bluetooth.md	Add description in Bluetooth docs for requiring NKRO to be disabled (#10359 )	2020-09-22 22:31:37 +10:00
feature_bootmagic.md	…
feature_combo.md	changed type of process_combo_event argument in tutorial (#10621 )	2020-10-13 02:14:37 +11:00
feature_command.md	…
feature_debounce_type.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
feature_dip_switch.md	add DIP_SWITCH_MATRIX_GRID support (#8772 )	2020-07-04 23:20:49 +09:00
feature_dynamic_macros.md	Fix typo in docs/feature_dynamic_macros (#10085 )	2020-08-19 22:59:59 +01:00
feature_encoders.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
feature_grave_esc.md	…
feature_haptic_feedback.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
feature_hd44780.md	…
feature_joystick.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
feature_key_lock.md	…
feature_layers.md	Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352 )	2020-07-16 22:27:55 +10:00
feature_layouts.md	…
feature_leader_key.md	Delete trailing period in documentation (#9416 )	2020-06-15 02:49:36 +10:00
feature_led_indicators.md	Indicator LEDs as config (#10816 )	2020-11-08 22:31:16 +00:00
feature_led_matrix.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
feature_macros.md	Remove unused `action_get_macro()` usages in user files (#11165 )	2021-01-11 01:25:45 -08:00
feature_mouse_keys.md	Add support for 8 buttons to mouse report (#10807 )	2021-01-28 04:38:34 +11:00
feature_oled_driver.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
feature_pointing_device.md	Add support for 8 buttons to mouse report (#10807 )	2021-01-28 04:38:34 +11:00
feature_ps2_mouse.md	fix(feature_ps2_mouse): fix Scroll Button example (#11669 )	2021-01-24 14:51:25 +00:00
feature_rawhid.md	Updated Raw HID docs to clarify packet/report length (#11211 )	2020-12-23 08:04:55 +11:00
feature_rgb_matrix.md	Merge remote-tracking branch 'origin/master' into develop	2021-01-30 11:01:46 +00:00
feature_rgblight.md	Merge remote-tracking branch 'upstream/master' into develop	2021-01-28 10:52:59 +11:00
feature_sequencer.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
feature_space_cadet.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
feature_split_keyboard.md	Add modifier state to the split keyboard transport (#10400 )	2020-12-17 16:21:26 +11:00
feature_stenography.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
feature_swap_hands.md	…
feature_tap_dance.md	Update features to use Custom Tapping Term when appropriate (#6259 )	2020-08-29 14:30:02 -07:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	Fix documentation so UCIS example compiles. (#11541 )	2021-01-14 11:11:59 +11:00
feature_userspace.md	Normalise include statements in core code (#11153 )	2020-12-11 13:45:24 +11:00
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11: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	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
getting_started_introduction.md	…
getting_started_make_guide.md	Update docs/getting_started_make_guide.md (#11373 )	2021-01-24 15:15:11 +09:00
getting_started_vagrant.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
hand_wire.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
hardware_avr.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
hardware_drivers.md	…
hardware_keyboard_guidelines.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +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	…
i2c_driver.md	Update i2c_driver.md (#10131 )	2020-08-22 14:06:16 +01:00
index.html	Simplify the visual flow of the getting started page (#11316 )	2020-12-27 16:56:10 +00:00
internals_defines.md	…
internals_gpio_control.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11: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	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
keycodes.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
keycodes_basic.md	Update keycode docs (#11343 )	2020-12-30 07:51:36 +11:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +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	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
newbs_flashing.md	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
newbs_getting_started.md	[Docs] add qmk setup home parameter (#11451 )	2021-01-28 04:39:58 +11: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	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
newbs_testing_debugging.md	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
one_shot_keys.md	Update one_shot_keys.md (#10917 )	2020-11-18 21:31:21 +00:00
other_eclipse.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
other_vscode.md	Update other_vscode.md of Japanese document (#10604 )	2020-10-15 03:24:26 +09:00
platformdev_chibios_earlyinit.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
platformdev_selecting_arm_mcu.md	Add documentation for selecting an Arm MCU (#9046 )	2020-06-10 23:32:58 +01:00
power.txt	…
pr_checklist.md	Recommend use of LED Indicator config (#10895 )	2020-11-16 14:16:42 +11:00
proton_c_conversion.md	Add board specific to Proton-C, with usual defaults turned on. (#10976 )	2020-12-03 13:04:28 +11:00
qmk.css	…
qmk_custom_dark.css	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
qmk_custom_light.css	Small tweaks to docs to make them more user friendly (#11518 )	2021-01-20 18:46:01 +00:00
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	[Docs] Clarify functionality of update_tri_layer_state (#10370 )	2020-09-21 11:35:26 -07:00
reference_configurator_support.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
reference_glossary.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
reference_info_json.md	Merge remote-tracking branch 'origin/master' into develop	2021-01-30 11:01:46 +00:00
reference_keymap_extras.md	Improved Language Specific Keycodes for US International and Extended Layouts (#11307 )	2021-01-02 15:54:48 +11:00
serial_driver.md	Configurable serial usart timeout (#11057 )	2020-11-30 03:29:35 -08:00
spi_driver.md	Adds AT90USB162 support (#11570 )	2021-01-29 19:53:56 -08:00
support.md	Fix capitalisation of "GitHub" (#9184 )	2020-05-25 19:43:14 -07:00
sw.js	…
syllabus.md	…
tap_hold.md	2020 November 28 Breaking Changes Update (#11053 )	2020-11-28 12:02:18 -08:00
translating.md	…
uart_driver.md	UART driver refactor (#11637 )	2021-01-27 17:42:49 +11:00
understanding_qmk.md	…
unit_testing.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
usb_nkro.txt	…
ws2812_driver.md	Add BGR byte order for WS2812 drivers (#11562 )	2021-01-16 08:42:30 +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

?> 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