홈 탐색 도움말
로그인
logic855
/
qmk_firmware
의 미러 https://github.com/qmk/qmk_firmware.git
1
0
포크 1
파일 이슈 0 위키
트리: e8d5792ae0
브랜치 태그
qmk_firmware
/
docs
QMK Bot e8d5792ae0 Merge remote-tracking branch 'origin/develop' into xap 2 년 전
..
ChangeLog 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 년 전
gitbook 4580d3a730 RGB improvements (#1684) 9 년 전
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 년 전
ja ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 3 년 전
zh-cn 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 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 e8d5792ae0 Merge remote-tracking branch 'origin/develop' into xap 2 년 전
adc_driver.md 272281f1a0 Add analog support for RP2040 (#19453) 3 년 전
apa102_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) 2 년 전
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 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 년 전
breaking_changes_history.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 년 전
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) 3 년 전
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 102c42b14b `qmk find`: usability improvements (#20440) 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 2f1cac6e9f [Docs] Code markdown amendment (#21323) 3 년 전
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) 3 년 전
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) 3 년 전
config_options.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 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 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 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 ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 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 1b637287a1 Default wear leveling logical size to half backing (#22006) 2 년 전
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 e1afcda1c0 Update code example to match description (#20528) 3 년 전
feature_audio.md 69fa02c37d Align audio keycode names (#18962) 3 년 전
feature_auto_shift.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) 2 년 전
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) 3 년 전
feature_backlight.md dd887eae36 [Core] Allow customizing PWM frequency (#21717) 3 년 전
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 3 년 전
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 년 전
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 3 년 전
feature_combo.md 5faa23d54c Keymap introspection for combos. (#19670) 3 년 전
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
feature_converters.md dbfbf6c2c4 Merge remote-tracking branch 'origin/master' into develop 3 년 전
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) 3 년 전
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 c9f619124d Encodermap direction define. (#20454) 3 년 전
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 년 전
feature_haptic_feedback.md 0b802defd4 haptic: further naming cleanups (#21682) 3 년 전
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 년 전
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 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 3 년 전
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) 3 년 전
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 5 년 전
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 8f22105289 Add and use I2C address defines for ISSI LED drivers (#22008) 2 년 전
feature_macros.md f07490bc09 Corrected duration example, should be number not string (#21839) 3 년 전
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop 3 년 전
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) 3 년 전
feature_oled_driver.md d5baa925e7 Merge remote-tracking branch 'origin/master' into develop 2 년 전
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) 3 년 전
feature_pointing_device.md 59eb8940b0 Make Pointing Device Auto Layer more configurable (#20061) 3 년 전
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 3 년 전
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) 2 년 전
feature_rawhid.md 8b7ac7f2ca Raw HID: documentation improvements (#21596) 3 년 전
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 3 년 전
feature_rgb_matrix.md 9d526b8d66 Added flower blooming on RGB Matrix effect (#21948) 2 년 전
feature_rgblight.md 7a761ebf7d Merge remote-tracking branch 'origin/master' into develop 2 년 전
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 년 전
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 년 전
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) 3 년 전
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) 3 년 전
feature_split_keyboard.md 99290b4c7e Add full solenoid support on split keyboards (#21583) 2 년 전
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 년 전
feature_stenography.md fcf8b804ed [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847) 3 년 전
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) 3 년 전
feature_tap_dance.md 2c70d38910 On-each-release tap dance function (#20255) 3 년 전
feature_tri_layer.md fe02abc479 [Core] Tri Layer Keys (#19795) 3 년 전
feature_unicode.md 70e34e491c Unicode, Unicodemap and UCIS refactor (#21659) 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 990ee8075e Fix typo in `feature_wpm.md` title (#20464) 3 년 전
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 년 전
flashing.md a0ea7a6b17 feat, docs: WB32 flashing (#21217) 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) 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 a4ed6ad0f5 Unicodemap keycodes rename (#21092) 3 년 전
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 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 년 전
index.html 90fc901624 mermaid? 4 년 전
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 3 년 전
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 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 f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 년 전
newbs_building_firmware_workflow.md 43ce7b0df5 [Docs] Highlight keymap name entry (#21138) 3 년 전
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 년 전
newbs_getting_started.md 4c6c387724 Add an emphasis on QMK MSYS terminal (#21168) 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 1ca34c2168 Fix VS code live share extension link (#21585) 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 bd2a33fe77 Add reminder about format-json to PR Checklist (#22055) 2 년 전
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 년 전
qmk_custom_dark.css e3c6467ab9 [Docs] Improve contrast for warnings in dark mode (#21928) 2 년 전
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 년 전
quantum_keycodes.md 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) 3 년 전
quantum_painter.md a360900fbb [Enhancement] QP Getters (#21171) 2 년 전
quantum_painter_lvgl.md 169b0f33f6 Lvgl rate control (#22049) 2 년 전
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 c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 년 전
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 년 전
reference_glossary.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 년 전
reference_info_json.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) 2 년 전
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 408d61dcfb Chibios SPI driver: allow some SPI pins to be left unassigned (#20315) 2 년 전
squeezing_avr.md 9d526b8d66 Added flower blooming on RGB Matrix effect (#21948) 2 년 전
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 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 3 년 전
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 년 전
uart_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 년 전
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) 3 년 전
unit_testing.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) 2 년 전
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 년 전
ws2812_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) 2 년 전
xap.md 90fc901624 mermaid? 4 년 전
xap_0.0.1.md 980699f3cf Fix xap docs gen + clarify some broadcast messages 3 년 전
xap_0.1.0.md 980699f3cf Fix xap docs gen + clarify some broadcast messages 3 년 전
xap_0.2.0.md 980699f3cf Fix xap docs gen + clarify some broadcast messages 3 년 전
xap_0.3.0.md 980699f3cf Fix xap docs gen + clarify some broadcast messages 3 년 전
xap_protocol.md 980699f3cf Fix xap docs gen + clarify some broadcast messages 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.