qmk/docs
2022-06-04 01:53:24 +01:00
..
ChangeLog Breaking changes for 2022q2. (#17221) 2022-05-29 07:50:21 +10:00
gitbook/images
internals
ja Removes terminal from QMK. (#17258) 2022-05-30 22:38:08 -07:00
zh-cn Removes terminal from QMK. (#17258) 2022-05-30 22:38:08 -07:00
_langs.md
_summary.md Removes terminal from QMK. (#17258) 2022-05-30 22:38:08 -07:00
.nojekyll
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_history.md stub changelog 2022-05-24 01:55:34 +01:00
breaking_changes_instructions.md
breaking_changes.md Fixup command sequencing for master/develop. (#17227) 2022-05-29 09:07:11 +10:00
chibios_upgrade_instructions.md
cli_commands.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
cli_configuration.md
cli_development.md
cli_tab_complete.md
cli.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md Added support for Wb32fq95 (#16871) 2022-05-23 15:57:24 +10:00
config_options.md [Core] Add compile/make macro to core (#15959) 2022-03-17 21:19:34 +00:00
configurator_architecture.md
configurator_default_keymaps.md
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
easy_maker.md
eeprom_driver.md initial 24lc32a (#16990) 2022-06-04 01:53:24 +01:00
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md Keymap FAQ updates (#17130) 2022-05-18 04:48:59 +10:00
faq_misc.md
feature_advanced_keycodes.md Add trailing parens to get_oneshot_mods in feature_advanced_keycodes.md (#17211) 2022-05-31 21:31:47 +10:00
feature_audio.md
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 2022-03-15 01:31:17 -07:00
feature_caps_word.md [Core] Add Caps Word feature to core (#16588) 2022-05-14 16:00:32 +10:00
feature_combo.md
feature_command.md
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_encoders.md Breaking changes for 2022q2. (#17221) 2022-05-29 07:50:21 +10:00
feature_grave_esc.md
feature_haptic_feedback.md [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 2022-05-15 21:24:35 +10:00
feature_hd44780.md HD44780 driver rework (#16370) 2022-03-19 17:57:22 +11:00
feature_joystick.md Joystick feature updates (#16732) 2022-03-26 18:38:09 +00:00
feature_key_lock.md
feature_key_overrides.md
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md Refine LED indicator documentation (#16304) 2022-04-16 17:36:07 -07:00
feature_led_matrix.md [Docs] Align LED Matrix docs with RGB matrix docs (#17140) 2022-05-20 09:13:40 -07:00
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md
feature_pointing_device.md Add support for multiple sensors to pmw3360 (#15996) 2022-04-19 20:29:17 +10:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Make SPI Mode configurable and change default mode to 3 (#17263) 2022-05-31 15:28:55 +10:00
feature_rgblight.md rgblight: Add functions to stop blinking one or all but one layer (#16859) 2022-04-17 00:02:32 +02:00
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Add uf2-split-* make targets. (#17257) 2022-05-31 08:04:50 +10:00
feature_st7565.md
feature_stenography.md [Docs] Update Steno Keycode Table (#17155) 2022-05-20 09:09:00 -07:00
feature_swap_hands.md
feature_tap_dance.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flash_driver.md
flashing_bootloadhid.md
flashing.md Merge remote-tracking branch 'origin/master' into develop 2022-05-30 22:06:28 +00:00
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
gpio_control.md
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md Fix i2c driver doc: Incorrect name (#16898) 2022-04-20 18:10:20 +01:00
index.html Fix anchors with <code> in table of content (#15169) 2022-05-14 23:08:32 +01:00
isp_flashing_guide.md
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md
keycodes.md [Core] Add Caps Word feature to core (#16588) 2022-05-14 16:00:32 +10:00
keymap.md
mod_tap.md
newbs_building_firmware_configurator.md
newbs_building_firmware.md
newbs_flashing.md
newbs_getting_started.md Recommend pillow as part of manual MSYS install (#17133) 2022-05-17 21:50:48 +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
newbs.md
one_shot_keys.md
other_eclipse.md
other_vscode.md
platformdev_chibios_earlyinit.md Make bootloader_jump for dualbank STM32 respect STM32_BOOTLOADER_DUAL_BANK_DELAY (#17178) 2022-05-30 23:20:10 -07:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md
power.txt
pr_checklist.md Update pr_checklist.md (#17122) 2022-05-17 14:20:13 +01:00
proton_c_conversion.md
qmk_custom_dark.css
qmk_custom_light.css
qmk.css
quantum_keycodes.md [Core] Add Reboot keycode to core (#15990) 2022-05-14 13:35:49 +10:00
quantum_painter_qff.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter_qgf.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter_rle.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
README.md
redirects.json
ref_functions.md Fix typo in docs/ref_functions.md (#16690) 2022-03-19 16:37:35 +00:00
reference_configurator_support.md
reference_glossary.md
reference_info_json.md
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 2022-05-15 21:27:01 +10:00
serial_driver.md
spi_driver.md
squeezing_avr.md [Core] Allow usage of AVRs minimal printf library (#16266) 2022-04-22 18:13:31 +10:00
support.md
sw.js
syllabus.md
tap_hold.md Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 2022-04-16 11:24:09 -07:00
translating.md
uart_driver.md
understanding_qmk.md Removes terminal from QMK. (#17258) 2022-05-30 22:38:08 -07:00
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.