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

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.