صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
logic855
/
qmk_firmware
mirrorاز https://github.com/qmk/qmk_firmware.git
1
0
انشعاب 1
پرونده‌ها مشکلات 0 ویکی
درخت: cd0043de8f
شاخه‌ها تگ‌ها
qmk_firmware
/
docs
Felix Teutsch b0e948c380 Update hand_wire.md (#23429) 2 سال پیش
..
ChangeLog dc046bc215 2024q1 `develop` changelog. (#23150) 2 سال پیش
gitbook 4580d3a730 RGB improvements (#1684) 9 سال پیش
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 سال پیش
ja e2dbe39b94 Removal of bootmagic lite terminology (#22979) 2 سال پیش
zh-cn 339bff6339 Move velocikey to within rgblight (#22123) 2 سال پیش
.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 dc046bc215 2024q1 `develop` changelog. (#23150) 2 سال پیش
adc_driver.md e884e42ce9 Generalise ADC driver source inclusion (#22448) 2 سال پیش
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 29f8fa35cf [Audio] Enable Complementary output for PWM Hardware driver (#22726) 2 سال پیش
breaking_changes.md dc046bc215 2024q1 `develop` changelog. (#23150) 2 سال پیش
breaking_changes_history.md dc046bc215 2024q1 `develop` changelog. (#23150) 2 سال پیش
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 cf3c8a2138 Give definition of 'CLI' for new users (#22647) 2 سال پیش
cli_commands.md d95182f5b5 [documentation] QMK migrate docs patch (#22646) 2 سال پیش
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 سال پیش
cli_development.md a638f6e5aa Fix minimum python version references (#22191) 2 سال پیش
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 a638f6e5aa Fix minimum python version references (#22191) 2 سال پیش
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) 3 سال پیش
config_options.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) 2 سال پیش
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 8895b13583 Documentation regarding user code removal/acceptance (#22507) 2 سال پیش
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) 3 سال پیش
custom_quantum_functions.md b8646bc40b Update naming convention for GPIO control macros (#23085) 2 سال پیش
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 29891b63f9 Update Atmel DFU driver assignments for dfu-programmer 1.x (#23165) 2 سال پیش
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 سال پیش
eeprom_driver.md bf6f13a2b0 Consolidate some EEPROM Driver configuration (#22321) 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) 4 سال پیش
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 7ae826476e Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480) 2 سال پیش
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 3 سال پیش
feature_bootmagic.md e2dbe39b94 Removal of bootmagic lite terminology (#22979) 2 سال پیش
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 3 سال پیش
feature_combo.md 7df44ffb75 Fix double code indenting (#23117) 2 سال پیش
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 سال پیش
feature_converters.md 2450fe28ee Add Imera converter (#22419) 2 سال پیش
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) 3 سال پیش
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) 3 سال پیش
feature_dip_switch.md 4682226e20 Keymap introspection for Dip Switches (#22543) 2 سال پیش
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 567f808ea5 [Doc] Use number indexes for encoder code example (#22980) 2 سال پیش
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 77e8867498 Fix joystick initialization (#22953) 2 سال پیش
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop 3 سال پیش
feature_key_overrides.md 50844a8e67 Fix typos: key-modifer→key-modifier and interacton→interaction (#22464) 2 سال پیش
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 b8646bc40b Update naming convention for GPIO control macros (#23085) 2 سال پیش
feature_led_matrix.md 3ba88f7798 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) 2 سال پیش
feature_macros.md ce81801480 Add latam spanish headers (#22542) 2 سال پیش
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 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) 2 سال پیش
feature_os_detection.md 80f3da36e5 [Core] Add OS detection callbacks (#21777) 2 سال پیش
feature_pointing_device.md 6b52c6d83d Cirque reachable calibration aide (#22803) 2 سال پیش
feature_programmable_button.md 17ae28f0e4 Fix doc for programmable buttons. (#22136) 2 سال پیش
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) 2 سال پیش
feature_rawhid.md 31fdf7d899 add pywinusb lib to list of example libs for HID (#22747) 2 سال پیش
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 3 سال پیش
feature_rgb_matrix.md 3ba88f7798 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) 2 سال پیش
feature_rgblight.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) 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 ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) 2 سال پیش
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 سال پیش
feature_stenography.md 786ebf8760 Remove requirement for `keymap_steno.h` include in keymaps (#22423) 2 سال پیش
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) 3 سال پیش
feature_tap_dance.md b824faca71 Align location of tap dance keycode (#22742) 2 سال پیش
feature_tri_layer.md 1080025973 Update feature_tri_layer.md - typo (#23275) 2 سال پیش
feature_unicode.md 509a2b40b7 Fix old usage of UNICODE_MODE_MAC (#22238) 2 سال پیش
feature_userspace.md 8895b13583 Documentation regarding user code removal/acceptance (#22507) 2 سال پیش
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 696bf80375 Clearer text about double tapping reset only working for boot after already having QMK running in board (#23042) 2 سال پیش
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 4 سال پیش
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 f0e219a1c8 Modify wording in 'getting_started_introduction.md' (#23232) 2 سال پیش
getting_started_make_guide.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 3 سال پیش
gpio_control.md b8646bc40b Update naming convention for GPIO control macros (#23085) 2 سال پیش
hand_wire.md b0e948c380 Update hand_wire.md (#23429) 2 سال پیش
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 سال پیش
hardware_keyboard_guidelines.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) 2 سال پیش
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 b8646bc40b Update naming convention for GPIO control macros (#23085) 2 سال پیش
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 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 a474cac2c3 Update keymap.md (#22834) 2 سال پیش
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 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) 2 سال پیش
newbs_external_userspace.md 5501e804ff QMK Userspace (#22222) 2 سال پیش
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 سال پیش
newbs_getting_started.md 8813bdf5dd Remove rosetta instructions for Apple Silicon (#22174) 2 سال پیش
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 8946aace5b Add instructions for debugging ARM with VSCode+BMP. (#11217) 2 سال پیش
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) 4 سال پیش
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) 4 سال پیش
platformdev_rp2040.md 61fa6949fb [Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839) 2 سال پیش
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 53f46893ce Updates to PR Checklist (#23318) 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) 3 سال پیش
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 5383335717 [Driver] ILI9486 on Quantum Painter (#18521) 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 f6709e65eb Add RGB matrix & LED Matrix support for IS31FL3729 (#21944) 2 سال پیش
reference_keymap_extras.md e67d2c2f6f Add Canadian French input locale (#21456) 2 سال پیش
serial_driver.md 7bff385840 Update serial_driver.md (#23035) 2 سال پیش
spi_driver.md c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) 2 سال پیش
squeezing_avr.md 2450fe28ee Add Imera converter (#22419) 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 87eaab600c Fixed non-executable codes in the documentation (#22600) 2 سال پیش
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 سال پیش
uart_driver.md 61fa6949fb [Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839) 2 سال پیش
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 سال پیش

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.