qmk_firmware/docs
MasterSpoon 0452ad9479
Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989)
Co-authored-by: Xelus22 <17491233+Xelus22@users.noreply.github.com>
2022-02-06 09:04:43 -08:00
..
ChangeLog [Core] Split support for pointing devices. (#15304) 2021-12-27 12:05:51 +11:00
gitbook/images
ja
zh-cn [Docs] zh-cn documentation translate: hand-wire (#15666) 2022-01-29 16:06:19 +00:00
.nojekyll
_langs.md Remove stale docs translations (#15737) 2022-01-04 18:11:24 -08:00
_summary.md
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
audio_driver.md
breaking_changes.md
breaking_changes_history.md
breaking_changes_instructions.md
chibios_upgrade_instructions.md
cli.md
cli_commands.md
cli_configuration.md
cli_development.md
cli_tab_complete.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md Add L432, L442. (#16016) 2022-01-24 08:49:36 +11:00
config_options.md Rename AdafruitBLE to BluefruitLE (#16127) 2022-01-30 17:29:42 +00:00
configurator_architecture.md
configurator_default_keymaps.md
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 2022-01-18 18:24:02 +00:00
configurator_troubleshooting.md
contributing.md update the Chinese translation based on the latest English version (#14924) 2022-01-18 18:24:02 +00:00
custom_matrix.md
custom_quantum_functions.md Point out that deferred execution needs to be enabled in rules.mk (#16196) 2022-02-04 03:44:51 +00:00
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
easy_maker.md update the Chinese translation based on the latest English version (#14924) 2022-01-18 18:24:02 +00:00
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md Rename AdafruitBLE to BluefruitLE (#16127) 2022-01-30 17:29:42 +00:00
feature_bootmagic.md
feature_combo.md New combo configuration options (#15083) 2022-01-09 12:02:25 -08:00
feature_command.md
feature_debounce_type.md Add sym_defer_pr debouncer type (#14948) 2021-12-27 13:44:56 +11:00
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_encoders.md [Docs] Update Encoder docs about multiple encoders (#16036) 2022-01-28 19:26:42 -08:00
feature_grave_esc.md Rename some Quantum keycodes (#15968) 2022-01-22 03:34:15 +00:00
feature_haptic_feedback.md Rip out old macro and action_function system (#16025) 2022-01-24 21:22:20 +00:00
feature_hd44780.md
feature_joystick.md
feature_key_lock.md
feature_key_overrides.md
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md
feature_led_matrix.md Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989) 2022-02-06 09:04:43 -08:00
feature_macros.md [Docs] feature_macro.md: minor formatting fix (#16205) 2022-02-05 08:15:21 +11:00
feature_midi.md
feature_mouse_keys.md Merge remote-tracking branch 'origin/master' into develop 2022-02-05 11:45:18 +00:00
feature_oled_driver.md [Docs] OLED documentation edits (#15977) 2022-01-27 15:56:20 +00:00
feature_pointing_device.md Remove default pointing device driver. (#16190) 2022-02-05 14:29:15 +00:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989) 2022-02-06 09:04:43 -08:00
feature_rgblight.md [Docs] RGB documentation formatting corrections (#15826) 2022-02-05 21:16:36 -08:00
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Merge remote-tracking branch 'origin/master' into develop 2022-01-12 22:06:23 +00:00
feature_st7565.md ST7565 invert (#13237) 2021-06-19 18:51:35 +10:00
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md [Docs] Update feature_tap_dance.md (#14931) 2022-01-08 19:26:44 -08:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 2021-12-27 11:52:56 +11:00
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
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html Remove stale docs translations (#15737) 2022-01-04 18:11:24 -08:00
internals_defines.md
internals_gpio_control.md Add open-drain GPIO support. (#15282) 2021-12-27 11:52:10 +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 Add a warning about USBtinyISP limitations to the ISP flashing guide (#15898) 2022-01-30 11:06:19 -08:00
keycodes.md Rename some Quantum keycodes (#15968) 2022-01-22 03:34:15 +00:00
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keymap.md Rip out old macro and action_function system (#16025) 2022-01-24 21:22:20 +00:00
mod_tap.md
newbs.md
newbs_building_firmware.md [Docs] Move QMK newbs build environment guide to next section (#15386) 2022-01-13 02:29:13 +00:00
newbs_building_firmware_configurator.md
newbs_flashing.md [Docs] newbs_flashing.md: add link to build environment section (#15654) 2022-01-10 16:54:22 -08:00
newbs_getting_started.md [Docs] Move QMK newbs build environment guide to next section (#15386) 2022-01-13 02:29:13 +00: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 Add Atom editor suggestion (#15969) 2022-01-22 02:48:35 +11:00
newbs_testing_debugging.md
one_shot_keys.md
other_eclipse.md update the Chinese translation based on the latest English version (#14924) 2022-01-18 18:24:02 +00:00
other_vscode.md
platformdev_chibios_earlyinit.md Fixes for bootloader refactor build failures (#15638) 2022-01-06 06:55:46 +11:00
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md Add some clarity regarding new board definitions (#16018) 2022-01-23 22:15:09 +00:00
proton_c_conversion.md
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md Rename some Quantum keycodes (#15968) 2022-01-22 03:34:15 +00:00
README.md
redirects.json
ref_functions.md fix typo (#15569) 2021-12-24 20:10:12 +00:00
reference_configurator_support.md
reference_glossary.md
reference_info_json.md CLI: Parse USB device version BCD (#14580) 2022-01-17 08:44:34 +11:00
reference_keymap_extras.md
serial_driver.md
spi_driver.md
squeezing_avr.md [Core] Add Pixel Flow RGB matrix effect (#15829) 2022-02-05 05:58:16 +11:00
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

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.