qmk_firmware/docs
Stefan Kerkmann fe680a8568
[Core] Split ChibiOS usart split driver in protocol and hardware driver part (#16669)
2022-06-18 08:04:17 +10:00
..
ChangeLog Breaking changes for 2022q2. (#17221) 2022-05-29 07:50:21 +10:00
gitbook/images
internals
ja tap-dance: Restructure code and document in more detail (#16394) 2022-06-13 22:12:55 +02:00
zh-cn Removes terminal from QMK. (#17258) 2022-05-30 22:38:08 -07:00
.nojekyll
CNAME
README.md
_langs.md
_summary.md Removes terminal from QMK. (#17258) 2022-05-30 22:38:08 -07:00
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 Fixup command sequencing for master/develop. (#17227) 2022-05-29 09:07:11 +10:00
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
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md Inform people that things may not work. (#17391) 2022-06-14 20:15:01 +10:00
config_options.md Add support for large Mouse Reports (#16371) 2022-06-08 18:39:16 -07: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
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
feature_caps_word.md
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_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
feature_macros.md
feature_midi.md Update feature_midi.md (#17390) 2022-06-14 11:12:52 +01:00
feature_mouse_keys.md
feature_oled_driver.md
feature_pointing_device.md Add support for large Mouse Reports (#16371) 2022-06-08 18:39:16 -07: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
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
feature_swap_hands.md
feature_tap_dance.md tap-dance: Restructure code and document in more detail (#16394) 2022-06-13 22:12:55 +02:00
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flash_driver.md
flashing.md Merge remote-tracking branch 'origin/master' into develop 2022-05-30 22:06:28 +00:00
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
gpio_control.md
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md docs: reflect systemd's change in language (#17322) 2022-06-06 23:29:59 +01:00
i2c_driver.md
index.html
isp_flashing_guide.md
keycodes.md
keycodes_basic.md
keycodes_magic.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
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
other_eclipse.md
other_vscode.md Update other_vscode.md (#17317) 2022-06-08 02:47:57 +01:00
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
proton_c_conversion.md
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
quantum_painter.md
quantum_painter_qff.md
quantum_painter_qgf.md
quantum_painter_rle.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md
reference_keymap_extras.md
serial_driver.md [Core] Split ChibiOS usart split driver in protocol and hardware driver part (#16669) 2022-06-18 08:04:17 +10:00
spi_driver.md
squeezing_avr.md
support.md
sw.js
syllabus.md
tap_hold.md
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

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.