صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
logic855
/
qmk_firmware
mirrorاز https://github.com/qmk/qmk_firmware.git
1
0
انشعاب 1
پرونده‌ها مشکلات 0 ویکی
درخت: 68da1e7ed4
شاخه‌ها تگ‌ها
qmk_firmware
/
docs
QMK Bot ce0555214d Merge remote-tracking branch 'origin/master' into develop 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 fcf8b804ed [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847) 3 سال پیش
zh-cn 73b376a881 [Chore] Remove stray mod tap interrupt defines and per key functions (#20347) 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 47966dc2a6 Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 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) 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 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 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 ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 3 سال پیش
feature_combo.md 387b64a79b [Docs] Remove combo count from array (#20511) 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 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 369c5a213d Add layer-cycle example (#19069) 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 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) 4 سال پیش
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 سال پیش
feature_rgb_matrix.md 47966dc2a6 Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 3 سال پیش
feature_rgblight.md 47966dc2a6 Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 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 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 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 990ee8075e Fix typo in `feature_wpm.md` title (#20464) 3 سال پیش
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) 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 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 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 3 سال پیش
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 12de0297ed Suggest `qmk list-keyboards` when testing build environment (#19471) 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) 4 سال پیش
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 d06ce0153b PR checklist: keyboard updates must go to `develop` (#20323) 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) 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 014aa0661e Fix Space Cadet md link (#14300) 5 سال پیش
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 47966dc2a6 Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 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.