1
0
precondition 6f2c173743 Expand on the differences between Caps Word and Caps Lock (#18139) 4 жил өмнө
..
ChangeLog 9b5b072255 2022q3 Changelog. (#18180) 4 жил өмнө
gitbook 4580d3a730 RGB improvements (#1684) 9 жил өмнө
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 жил өмнө
ja f27b617f36 [Core] Process all changed keys in one scan loop, deprecate `QMK_KEYS_PER_SCAN` (#15292) 4 жил өмнө
zh-cn 0da6562c4d Make default layer size 16-bit (#15286) 4 жил өмнө
.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 9b5b072255 2022q3 Changelog. (#18180) 4 жил өмнө
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 жил өмнө
api_development_environment.md 99850aabca Add API documentation 6 жил өмнө
api_development_overview.md 99850aabca Add API documentation 6 жил өмнө
api_docs.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
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 c0763363db [Docs] Fix tables in Audio driver document (#17780) 4 жил өмнө
breaking_changes.md 9b5b072255 2022q3 Changelog. (#18180) 4 жил өмнө
breaking_changes_history.md 9b5b072255 2022q3 Changelog. (#18180) 4 жил өмнө
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 жил өмнө
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 жил өмнө
cli.md fcf150bd82 Streamline the macos install process 6 жил өмнө
cli_commands.md 5e2ffe7d8f CLI: Teaching the CLI to flash binaries (#16584) 4 жил өмнө
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
cli_development.md da6d6ce2e1 Some docs improvements (#15845) 4 жил өмнө
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) 4 жил өмнө
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 4 жил өмнө
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) 4 жил өмнө
config_options.md 154d35ac14 Remove `UNUSED_PINS` (#17931) 4 жил өмнө
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 жил өмнө
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
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 f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 жил өмнө
custom_matrix.md 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) 4 жил өмнө
custom_quantum_functions.md 837a57b3c5 Adjust the hierarchy of chapter `Deferred Execution` (#18075) 4 жил өмнө
data_driven_config.md e6a1afb8f1 [Docs] Fix typo in data driven config docs (#18095) 4 жил өмнө
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 жил өмнө
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 жил өмнө
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 683eeca2e2 [Docs] Fix custom debug function and sample output (#17790) 4 жил өмнө
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 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 жил өмнө
feature_advanced_keycodes.md 8153b55e07 Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md (#17211) 4 жил өмнө
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 жил өмнө
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 жил өмнө
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) 4 жил өмнө
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 жил өмнө
feature_caps_word.md 6f2c173743 Expand on the differences between Caps Word and Caps Lock (#18139) 4 жил өмнө
feature_combo.md a1f0208797 [Docs] Use layer number as example for COMBO_ONLY_FROM_LAYER (#18072) 4 жил өмнө
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 жил өмнө
feature_converters.md a645301c82 Add Bonsai C4 converter (#17711) 4 жил өмнө
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 жил өмнө
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 жил өмнө
feature_dynamic_macros.md 9dc7b9d40c Added Wait time to sending each Keys for Dynamic Macros function (#16800) 4 жил өмнө
feature_encoders.md 70c6b183df [Docs] Refactor code examples (#18003) 4 жил өмнө
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 жил өмнө
feature_haptic_feedback.md f090881aeb [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 4 жил өмнө
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 4 жил өмнө
feature_joystick.md c05e8afe45 Joystick feature updates (#16732) 4 жил өмнө
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) 4 жил өмнө
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 жил өмнө
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
feature_leader_key.md b1f8622513 [Docs] Update feature_leader_key.md (#16344) 4 жил өмнө
feature_led_indicators.md a5a4597311 Refine LED indicator documentation (#16304) 4 жил өмнө
feature_led_matrix.md f296e1d1e2 [Docs] Align LED Matrix docs with RGB matrix docs (#17140) 4 жил өмнө
feature_macros.md d02cefe613 implement `tap_code16_delay` (#17748) 4 жил өмнө
feature_midi.md 026d0e8bf1 Update feature_midi.md (#17390) 4 жил өмнө
feature_mouse_keys.md c725b6bf89 [Core] Mouse key kinetic mode fix (#17176) 4 жил өмнө
feature_oled_driver.md c10c2575b8 Remove OLED driver Split Common warning (#17862) 4 жил өмнө
feature_pointing_device.md ccdba43e59 Create generic Pointing Device Pin defines (#17776) 4 жил өмнө
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 5 жил өмнө
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 4 жил өмнө
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
feature_rgb_matrix.md 06391314cd Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
feature_rgblight.md eb417b3aaf Add deprecated check for RGBLIGHT_ANIMATIONS (#17832) 4 жил өмнө
feature_secure.md 2a3dd95229 Add basic secure docs (#17577) 4 жил өмнө
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) 4 жил өмнө
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 жил өмнө
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
feature_split_keyboard.md 1204cbb7ea Update feature_split_keyboard.md to add extra detail about left and right matrices. (#17492) 4 жил өмнө
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 8d5eacb7dd Add support for encoder mapping. (#13286) 4 жил өмнө
feature_tap_dance.md d942c03be6 Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 жил өмнө
feature_unicode.md 6fc7c03e95 Added emacs as an "operating system" for input mode. (#16949) 4 жил өмнө
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 жил өмнө
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 жил өмнө
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 d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) 4 жил өмнө
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
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) 5 жил өмнө
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 жил өмнө
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 жил өмнө
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) 4 жил өмнө
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 жил өмнө
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 жил өмнө
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 a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) 4 жил өмнө
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
keycodes_magic.md 871eeae4ea PoC: Swap Escape and Caps (#16336) 4 жил өмнө
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
keymap.md da6d6ce2e1 Some docs improvements (#15845) 4 жил өмнө
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 жил өмнө
newbs_building_firmware.md d3584be431 [Docs] Update newbs_building_firmware.md (#16333) 4 жил өмнө
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 жил өмнө
newbs_building_firmware_workflow.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) 4 жил өмнө
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) 4 жил өмнө
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) 4 жил өмнө
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 b56282756b [Docs] Clean up some code block languages (#14434) 5 жил өмнө
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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 жил өмнө
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 жил өмнө
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) 4 жил өмнө
platformdev_blackpill_f411.md 8973835183 [Docs] Add information about WeAct Blackpill F411 (#16755) 4 жил өмнө
platformdev_chibios_earlyinit.md bbab8eb993 Make bootloader_jump for dualbank STM32 respect STM32_BOOTLOADER_DUAL_BANK_DELAY (#17178) 4 жил өмнө
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) 4 жил өмнө
platformdev_rp2040.md 5846b40f74 RP2040 emulated EEPROM. (#17519) 4 жил өмнө
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 жил өмнө
porting_your_keyboard_to_qmk.md 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) 4 жил өмнө
power.txt bb53635f33 Trim trailing whitespace 8 жил өмнө
pr_checklist.md 2f4ad40561 [Docs] update pr_checklist.md with info about data-driven (#18068) 4 жил өмнө
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 2bdd73f801 Add ST7735 driver to Quantum Painter (#17848) 4 жил өмнө
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) 7 жил өмнө
ref_functions.md 71472a1692 Update ref_functions.md (replaced deprecated `RESET`) (#17436) 4 жил өмнө
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 жил өмнө
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 жил өмнө
reference_info_json.md 82f0263e41 Merge remote-tracking branch 'origin/master' into develop 4 жил өмнө
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 жил өмнө
serial_driver.md d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) 4 жил өмнө
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 жил өмнө
squeezing_avr.md 286dd6abe6 [Docs] Update list of "ARM-based ProMicro replacements" (#18083) 4 жил өмнө
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 жил өмнө
sw.js 303f425c6b Fix up info boxes. 8 жил өмнө
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 жил өмнө
tap_hold.md 8f585153c4 Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 4 жил өмнө
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 8545473307 Removes terminal from QMK. (#17258) 4 жил өмнө
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 жил өмнө
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 жил өмнө
ws2812_driver.md d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) 4 жил өмнө

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.