qmk/docs
Albert Y e1afcda1c0
Update code example to match description (#20528)
2023-04-23 12:56:45 -06:00
..
ChangeLog Add changelog for Leader Key refactor (#19953) 2023-02-27 20:28:15 +11:00
gitbook/images
internals
ja [Doc]Remove depracted extension links in vscode guide (#19842) 2023-02-14 03:23:36 +00:00
zh-cn [Doc]Remove depracted extension links in vscode guide (#19842) 2023-02-14 03:23:36 +00:00
.nojekyll
CNAME
README.md
_langs.md
_summary.md Stub changelog 2023-02-19 20:23:01 +00: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 Update branch names to reflect configurator's new deployment. (#19999) 2023-03-03 14:16:06 +11:00
breaking_changes_history.md Stub changelog 2023-02-19 20:23:01 +00:00
breaking_changes_instructions.md
chibios_upgrade_instructions.md Update branch names to reflect configurator's new deployment. (#19999) 2023-03-03 14:16:06 +11:00
cli.md
cli_commands.md Add `qmk find` command, reuse logic for `qmk mass-compile`. (#20139) 2023-03-16 20:35:49 +00:00
cli_configuration.md
cli_development.md
cli_tab_complete.md
coding_conventions_c.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md Make Magic handling more consistent in Action Keycode handling (#9126) 2023-02-13 04:48:14 +11:00
configurator_architecture.md
configurator_default_keymaps.md Reallocate SAFE_RANGE (#19909) 2023-02-23 09:49:07 +11:00
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md Remove matrix_init_quantum/matrix_scan_quantum (#19806) 2023-02-11 03:47:17 +00:00
custom_quantum_functions.md [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 2023-03-15 16:55:18 -06:00
data_driven_config.md Format DD mappings and schemas (#18924) 2022-11-08 01:05:08 +00:00
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
faq_misc.md
feature_advanced_keycodes.md Update code example to match description (#20528) 2023-04-23 12:56:45 -06:00
feature_audio.md
feature_auto_shift.md
feature_autocorrect.md Document Autocorrect callback functions (#20115) 2023-03-13 13:34:23 -06:00
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_caps_word.md
feature_combo.md [Docs] Remove combo count from array (#20511) 2023-04-20 08:47:26 -07:00
feature_command.md
feature_converters.md Convertors documentation: Removed duplicate table entry (#20360) 2023-04-07 23:11:56 +01:00
feature_debounce_type.md Add debounce time description (#20333) 2023-04-04 12:15:00 +10:00
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_eeprom.md
feature_encoders.md Elaborate on keyboard level encoder functionality (#19839) 2023-02-15 15:40:47 -07:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md
feature_key_lock.md
feature_key_overrides.md [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 2023-03-15 16:55:18 -06:00
feature_layers.md Update documentation for LM(layer, mod) (#19284) 2023-02-11 20:37:30 +00:00
feature_layouts.md
feature_leader_key.md Refactor Leader key feature (#19632) 2023-02-13 03:19:02 +11:00
feature_led_indicators.md
feature_led_matrix.md
feature_macros.md
feature_midi.md Merge remote-tracking branch 'origin/master' into develop 2023-02-08 02:21:22 +00:00
feature_mouse_keys.md
feature_oled_driver.md
feature_os_detection.md
feature_pointing_device.md [Documentation] Pointing device minor rewrite (#19641) 2023-03-23 22:35:02 +00:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md
feature_rgblight.md
feature_secure.md
feature_send_string.md
feature_sequencer.md Align sequencer keycodes (#19875) 2023-02-18 15:44:36 +00:00
feature_space_cadet.md
feature_split_keyboard.md [Docs] Discuss layout macro (#19803) 2023-03-06 11:24:56 -08:00
feature_st7565.md
feature_stenography.md
feature_swap_hands.md Add swap hands status function (#19831) 2023-02-14 12:44:18 -08:00
feature_tap_dance.md
feature_tri_layer.md [Core] Tri Layer Keys (#19795) 2023-02-12 10:23:07 +11:00
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md Fix typo in `feature_wpm.md` title (#20464) 2023-04-16 15:14:08 +01:00
flash_driver.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
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
index.html
isp_flashing_guide.md Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 2023-04-19 19:23:50 +01:00
keycodes.md Align magic keycodes (#19877) 2023-02-23 08:14:29 +11:00
keycodes_basic.md Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 2023-02-19 18:59:50 +11:00
keycodes_magic.md Align magic keycodes (#19877) 2023-02-23 08:14:29 +11:00
keycodes_us_ansi_shifted.md
keymap.md [Docs] Change defines to enums in examples (#19793) 2023-02-10 02:39:35 -08:00
mod_tap.md
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md Add disable git safe directory check step (#20040) 2023-03-07 01:05:34 +00:00
newbs_flashing.md
newbs_getting_started.md Suggest `qmk list-keyboards` when testing build environment (#19471) 2023-04-03 15:42:14 +10:00
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md [Docs] Resynchronizing Your Branch including submodules (#19268) 2023-02-11 12:07:51 -07:00
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 Add recommendations for VSCode intellisense (#19402) 2023-04-03 10:05:48 +10:00
platformdev_blackpill_f4x1.md
platformdev_chibios_earlyinit.md
platformdev_proton_c.md
platformdev_rp2040.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 2023-02-12 23:02:05 +00:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md [Docs] Discuss layout macro (#19803) 2023-03-06 11:24:56 -08:00
power.txt
pr_checklist.md PR checklist: keyboard updates must go to `develop` (#20323) 2023-04-03 16:34:03 +10:00
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
quantum_painter.md
quantum_painter_lvgl.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 Remove `all` from list of animations in `info.json` (#19978) 2023-03-01 02:55:14 +00:00
reference_keymap_extras.md
serial_driver.md Fix serial_driver.md list item numbering (#19819) 2023-02-12 17:05:46 +00:00
spi_driver.md
squeezing_avr.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 2023-02-12 23:02:05 +00:00
support.md
support_deprecation_policy.md Initial deprecation policy documentation. (#19908) 2023-03-03 14:16:32 +11:00
sw.js
syllabus.md
tap_hold.md
translating.md
uart_driver.md
understanding_qmk.md Update understanding_qmk.md (#19664) 2023-01-24 15:17:24 +00: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.