qmk_firmware/docs
2020-08-16 18:58:33 +01:00
..
ChangeLog
de
es Remove DESCRIPTION (#9732) 2020-07-16 15:49:18 +10:00
fr-fr
gitbook/images
he-il
ja Update Japanese translation of _summary.md. (#10051) 2020-08-16 18:58:33 +01:00
pt-br
ru-ru
zh-cn Remove unnecessary break after return from documentation (#9892) 2020-07-31 15:58:55 +01:00
.nojekyll
_langs.md
_summary.md Add PR checklist document. (#9913) 2020-08-07 06:16:14 +10:00
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
breaking_changes.md
breaking_changes_instructions.md
cli.md
cli_commands.md
cli_configuration.md
cli_development.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md Remove DESCRIPTION (#9732) 2020-07-16 15:49:18 +10:00
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md Remove unnecessary break after return from documentation (#9892) 2020-07-31 15:58:55 +01:00
documentation_best_practices.md [Docs] fix file path (#9540) 2020-06-25 15:58:36 +10:00
documentation_templates.md
driver_installation_zadig.md MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736) 2020-07-16 18:01:34 +01:00
eeprom_driver.md
faq_build.md Docs: update ModemManager recommendation (#9328) 2020-07-07 19:22:38 +01:00
faq_debug.md
faq_general.md
faq_keymap.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md
feature_backlight.md Backlight docs wordsmithing (#9631) 2020-07-03 10:05:59 +01:00
feature_bluetooth.md
feature_bootmagic.md
feature_combo.md
feature_command.md
feature_debounce_type.md
feature_dip_switch.md add DIP_SWITCH_MATRIX_GRID support (#8772) 2020-07-04 23:20:49 +09:00
feature_dynamic_macros.md Allowing Pressing the Start Buttons Again to Stop Dynamic Macro Recording (#9446) 2020-07-07 21:59:13 +01:00
feature_encoders.md Adding information to feature_encoders.md (#9486) 2020-06-21 17:10:01 +10:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
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
feature_led_matrix.md
feature_macros.md [Docs] Improve Unicode documentation (#8676) 2020-06-20 21:58:48 +01:00
feature_mouse_keys.md Implemented New MK_COMBINED Functionality (#9557) 2020-07-21 09:28:38 +10:00
feature_oled_driver.md OLED driver function to set pixels (#9713) 2020-07-16 15:48:04 +10:00
feature_pointing_device.md
feature_ps2_mouse.md Add movement hook to ps2_mouse (#8805) 2020-07-02 21:54:15 +01:00
feature_rawhid.md
feature_rgb_matrix.md Add Indicator flag for RGB Matrix (#9933) 2020-08-05 13:29:04 -07:00
feature_rgblight.md Improve keycode handling for RGB (#7677) 2020-06-22 09:38:58 +01:00
feature_space_cadet.md
feature_split_keyboard.md add SPLIT_HAND_MATRIX_GRID support (#8685) 2020-07-04 15:04:47 +01:00
feature_stenography.md fix typo (#9695) 2020-07-11 23:06:33 +10:00
feature_swap_hands.md
feature_tap_dance.md Clean up Tap Dance docs (#9372) 2020-06-17 17:10:35 -07:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md [Docs] Improve Unicode documentation (#8676) 2020-06-20 21:58:48 +01:00
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flashing.md
flashing_bootloadhid.md
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
hand_wire.md
hardware_avr.md Remove DESCRIPTION (#9732) 2020-07-16 15:49:18 +10:00
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
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 Guide (#9748) 2020-07-18 21:24:23 +01:00
keycodes.md
keycodes_basic.md
keycodes_us_ansi_shifted.md
keymap.md
mod_tap.md
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_flashing.md
newbs_getting_started.md Update newbs MSYS2 pacman instructions (#9445) 2020-06-21 10:54:53 +01: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 [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380) 2020-06-15 02:55:00 -07:00
other_eclipse.md
other_vscode.md [Docs] small text and formatting fixes in vscode manual (#9156) 2020-08-03 19:49:26 -07:00
platformdev_chibios_earlyinit.md
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md Add PR checklist document. (#9913) 2020-08-07 06:16:14 +10:00
proton_c_conversion.md
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
README.md
redirects.json
ref_functions.md Remove unnecessary break after return from documentation (#9892) 2020-07-31 15:58:55 +01:00
reference_configurator_support.md
reference_glossary.md fixed link to Eclipse instructions (#9647) 2020-07-05 08:50:01 +10:00
reference_info_json.md
reference_keymap_extras.md [Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644) 2020-07-08 19:55:02 +01:00
serial_driver.md
spi_driver.md
support.md
sw.js
syllabus.md
tap_hold.md Add missing bracket for Tap-Hold code sample (#9675) 2020-07-08 13:40:13 +10:00
translating.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt
ws2812_driver.md Fix incorrect delay when setting WS2812 (and similar) leds (#9302) 2020-06-20 12:59:28 +10:00

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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:

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.