precondition 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 лет назад
..
ChangeLog b865b9e170 Add changelog for Leader Key refactor (#19953) 3 лет назад
gitbook 4580d3a730 RGB improvements (#1684) 9 лет назад
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 лет назад
ja 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 лет назад
zh-cn 4cf8f69a4b Remove Vagrant due to bit-rot. (#20000) 3 лет назад
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 лет назад
CNAME 4d26137e2a Create CNAME 8 лет назад
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 лет назад
_summary.md 4cf8f69a4b Remove Vagrant due to bit-rot. (#20000) 3 лет назад
adc_driver.md 272281f1a0 Add analog support for RP2040 (#19453) 3 лет назад
api_development_environment.md 99850aabca Add API documentation 6 лет назад
api_development_overview.md 99850aabca Add API documentation 6 лет назад
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 лет назад
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 лет назад
audio_driver.md 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 3 лет назад
breaking_changes.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) 3 лет назад
breaking_changes_history.md f5ccd04a5f Stub changelog 3 лет назад
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 лет назад
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) 3 лет назад
cli.md fcf150bd82 Streamline the macos install process 6 лет назад
cli_commands.md 1b3f7fcf7d Add `qmk find` command, reuse logic for `qmk mass-compile`. (#20139) 3 лет назад
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
cli_development.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) 4 лет назад
coding_conventions_c.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) 3 лет назад
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) 4 лет назад
config_options.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 лет назад
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 лет назад
configurator_default_keymaps.md 961f0b7b2d Reallocate SAFE_RANGE (#19909) 3 лет назад
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 лет назад
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 лет назад
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 лет назад
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 лет назад
contributing.md 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) 3 лет назад
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) 3 лет назад
custom_quantum_functions.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 3 лет назад
data_driven_config.md 479d8de622 Format DD mappings and schemas (#18924) 3 лет назад
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 лет назад
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) 3 лет назад
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 лет назад
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) 4 лет назад
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) 3 лет назад
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 лет назад
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) 4 лет назад
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
feature_advanced_keycodes.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 3 лет назад
feature_audio.md 69fa02c37d Align audio keycode names (#18962) 3 лет назад
feature_auto_shift.md 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 3 лет назад
feature_autocorrect.md a71e58270c Document Autocorrect callback functions (#20115) 3 лет назад
feature_backlight.md 219afaba42 Reworked backlight keycodes. (#18961) 3 лет назад
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) 3 лет назад
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 лет назад
feature_caps_word.md a80b886751 Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) 3 лет назад
feature_combo.md ec3c2b75de [Docs] Add mod-tap section header (#20041) 3 лет назад
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 лет назад
feature_converters.md 46bbb81dd2 Add RP2040 Community Edition alias for Liatris (#19966) 3 лет назад
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 лет назад
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) 3 лет назад
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 лет назад
feature_dynamic_macros.md 68efea70b2 Add direction to dynamic_macro_record_start_user (#19689) 3 лет назад
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) 3 лет назад
feature_encoders.md 9cf58ec834 Elaborate on keyboard level encoder functionality (#19839) 3 лет назад
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 лет назад
feature_haptic_feedback.md e4d2ba9a4d Align haptic feedback keycode names (#18964) 3 лет назад
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 4 лет назад
feature_joystick.md 917d93e968 [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) 3 лет назад
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop 3 лет назад
feature_key_overrides.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 3 лет назад
feature_layers.md 21f4375393 Update documentation for LM(layer, mod) (#19284) 3 лет назад
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
feature_leader_key.md bbf7a20b33 Refactor Leader key feature (#19632) 3 лет назад
feature_led_indicators.md 1124bbc1db Remove deprecated led_set_kb (#19273) 3 лет назад
feature_led_matrix.md b56ffc8920 docs: Fix IS31FL3743A driver name (#19518) 3 лет назад
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) 3 лет назад
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop 3 лет назад
feature_mouse_keys.md 2a61bfc27d add "inertia" mode for mouse keys (#18774) 3 лет назад
feature_oled_driver.md a5c2eea6c1 Update OLED doc (#19213) 3 лет назад
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) 3 лет назад
feature_pointing_device.md 9a68472da8 Added PMW3320 driver (#19543) 3 лет назад
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 3 лет назад
feature_ps2_mouse.md 0237ff0c62 [Core] Rework PS/2 driver selection (#17892) 3 лет назад
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
feature_rgb_matrix.md 65a80f411f Clean up APA102 config and add DD mapping (#20159) 3 лет назад
feature_rgblight.md 65a80f411f Clean up APA102 config and add DD mapping (#20159) 3 лет назад
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 лет назад
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) 4 лет назад
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) 3 лет назад
feature_space_cadet.md 002b58f0e4 Normalise Space Cadet keycodes (#18864) 3 лет назад
feature_split_keyboard.md a518e1e5d8 Sync activity timestamps between sides. (#20192) 3 лет назад
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 лет назад
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) 4 лет назад
feature_swap_hands.md 9908ed7ecd Add swap hands status function (#19831) 3 лет назад
feature_tap_dance.md 1978007fae Tap Dance: remove `qk_` prefix (#19313) 3 лет назад
feature_tri_layer.md fe02abc479 [Core] Tri Layer Keys (#19795) 3 лет назад
feature_unicode.md ea96799970 Merge remote-tracking branch 'origin/master' into develop 3 лет назад
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 лет назад
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) 3 лет назад
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 лет назад
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 лет назад
flashing.md 82a94ea1bd Add f303 to tinyuf2 bootloader support (#19620) 3 лет назад
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 4 лет назад
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 лет назад
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 лет назад
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 4 лет назад
gpio_control.md cf935d97ae Fix functions with empty params (#19647) 3 лет назад
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) 4 лет назад
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 лет назад
hardware_keyboard_guidelines.md 4704a4e053 Merge remote-tracking branch 'origin/master' into develop 3 лет назад
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) 4 лет назад
i2c_driver.md 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) 4 лет назад
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 4 лет назад
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 4 лет назад
keycodes.md 403b0addea Align magic keycodes (#19877) 3 лет назад
keycodes_basic.md 0152dd811d Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 3 лет назад
keycodes_magic.md 403b0addea Align magic keycodes (#19877) 3 лет назад
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 лет назад
keymap.md 95671148a4 [Docs] Change defines to enums in examples (#19793) 3 лет назад
mod_tap.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 лет назад
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 лет назад
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) 3 лет назад
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
newbs_building_firmware_workflow.md c7f58145fb Update qmk_cli container references (#20154) 3 лет назад
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) 4 лет назад
newbs_getting_started.md 99a39a1198 Update newbs_getting_started to include instructions for apple silicon (#19579) 3 лет назад
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_git_resynchronize_a_branch.md f667821ed3 [Docs] Resynchronizing Your Branch including submodules (#19268) 3 лет назад
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) 4 лет назад
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
one_shot_keys.md 9ddb0165a4 fix typo (#19189) 3 лет назад
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 лет назад
other_vscode.md ec83c0b185 Add recommendations for VSCode intellisense (#19402) 3 лет назад
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 3 лет назад
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 лет назад
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) 4 лет назад
platformdev_rp2040.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 лет назад
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 лет назад
porting_your_keyboard_to_qmk.md f067f42305 [Docs] Discuss layout macro (#19803) 3 лет назад
power.txt bb53635f33 Trim trailing whitespace 8 лет назад
pr_checklist.md 9c79d2933c [Doc] Update PR checklist (#19988) 3 лет назад
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 лет назад
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 лет назад
quantum_keycodes.md a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) 4 лет назад
quantum_painter.md cd94ba031c Quantum Painter QoL enhancements -- auto-poweroff, auto-flush, buffer sizing (#20013) 3 лет назад
quantum_painter_lvgl.md cf935d97ae Fix functions with empty params (#19647) 3 лет назад
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) 4 лет назад
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) 4 лет назад
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) 4 лет назад
redirects.json d569f08771 Configuration system for CLI (#6708) 6 лет назад
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 лет назад
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 лет назад
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 4 лет назад
reference_info_json.md 3fc9c03559 Remove `all` from list of animations in `info.json` (#19978) 3 лет назад
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 лет назад
serial_driver.md 3f45fd4924 Fix serial_driver.md list item numbering (#19819) 3 лет назад
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 лет назад
squeezing_avr.md 46bbb81dd2 Add RP2040 Community Edition alias for Liatris (#19966) 3 лет назад
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
support_deprecation_policy.md d1a430b348 Initial deprecation policy documentation. (#19908) 3 лет назад
sw.js 303f425c6b Fix up info boxes. 8 лет назад
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 лет назад
tap_hold.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 лет назад
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 лет назад
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 лет назад
understanding_qmk.md 419a7944a4 Update understanding_qmk.md (#19664) 3 лет назад
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 лет назад
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 лет назад
ws2812_driver.md 647c2835e6 WS2812 driver improvements (#20262) 3 лет назад

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](newbs_building_firmware_configurator.md)
User friendly graphical interfaces, no programming knowledge required. ?> **Advanced** [Use The Source](newbs.md)
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.