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: 2450fe28ee
Branches Tags
qmk_firmware
/
docs
leah-splitkb 2450fe28ee Add Imera converter (#22419) il y a 2 ans
..
ChangeLog 07e7dd8fc1 `develop` 2023q4 changelog (#22552) il y a 2 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 339bff6339 Move velocikey to within rgblight (#22123) il y a 2 ans
zh-cn 339bff6339 Move velocikey to within rgblight (#22123) il y a 2 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 07e7dd8fc1 `develop` 2023q4 changelog (#22552) il y a 2 ans
adc_driver.md e884e42ce9 Generalise ADC driver source inclusion (#22448) il y a 2 ans
apa102_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) il y a 2 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 07e7dd8fc1 `develop` 2023q4 changelog (#22552) il y a 2 ans
breaking_changes_history.md 07e7dd8fc1 `develop` 2023q4 changelog (#22552) il y a 2 ans
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) il y a 3 ans
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) il y a 3 ans
cli.md a638f6e5aa Fix minimum python version references (#22191) il y a 2 ans
cli_commands.md 5501e804ff QMK Userspace (#22222) il y a 2 ans
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) il y a 6 ans
cli_development.md a638f6e5aa Fix minimum python version references (#22191) il y a 2 ans
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) il y a 4 ans
coding_conventions_c.md 2f1cac6e9f [Docs] Code markdown amendment (#21323) il y a 3 ans
coding_conventions_python.md a638f6e5aa Fix minimum python version references (#22191) il y a 2 ans
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) il y a 3 ans
config_options.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 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 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) il y a 2 ans
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) il y a 3 ans
custom_quantum_functions.md 07e7dd8fc1 `develop` 2023q4 changelog (#22552) il y a 2 ans
data_driven_config.md ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 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 3 ans
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) il y a 4 ans
eeprom_driver.md bf6f13a2b0 Consolidate some EEPROM Driver configuration (#22321) il y a 2 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 3 ans
feature_advanced_keycodes.md e1afcda1c0 Update code example to match description (#20528) il y a 3 ans
feature_audio.md 69fa02c37d Align audio keycode names (#18962) il y a 3 ans
feature_auto_shift.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) il y a 2 ans
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) il y a 3 ans
feature_backlight.md 7ae826476e Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480) il y a 2 ans
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 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 5faa23d54c Keymap introspection for combos. (#19670) il y a 3 ans
feature_command.md a03aa301de Remove Full Bootmagic (#13846) il y a 5 ans
feature_converters.md 2450fe28ee Add Imera converter (#22419) il y a 2 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 c9f619124d Encodermap direction define. (#20454) il y a 3 ans
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) il y a 4 ans
feature_haptic_feedback.md 0b802defd4 haptic: further naming cleanups (#21682) il y a 3 ans
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) il y a 3 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 50844a8e67 Fix typos: key-modifer→key-modifier and interacton→interaction (#22464) il y a 2 ans
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) il y a 3 ans
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 4 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 84df69572c Infer LED DRIVER_COUNT from configured addresses (#22311) il y a 2 ans
feature_macros.md f07490bc09 Corrected duration example, should be number not string (#21839) il y a 2 ans
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop il y a 3 ans
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) il y a 3 ans
feature_oled_driver.md 3ef06aa732 Improve and Cleanup Shutdown callbacks (#21060) il y a 2 ans
feature_os_detection.md 147865cf57 Migrate some common features to generic (#22403) il y a 2 ans
feature_pointing_device.md 68722d35a3 Azoteq IQS5xx support (#22280) il y a 2 ans
feature_programmable_button.md 17ae28f0e4 Fix doc for programmable buttons. (#22136) il y a 2 ans
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) il y a 2 ans
feature_rawhid.md 8b7ac7f2ca Raw HID: documentation improvements (#21596) il y a 3 ans
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) il y a 3 ans
feature_rgb_matrix.md 65b5969ed5 New RGB Animations - 4 "Starlight" Animation Variations (#22212) il y a 2 ans
feature_rgblight.md c9afacccf4 Merge remote-tracking branch 'origin/master' into develop il y a 2 ans
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) il y a 3 ans
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) il y a 3 ans
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) il y a 3 ans
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) il y a 3 ans
feature_split_keyboard.md 99290b4c7e Add full solenoid support on split keyboards (#21583) il y a 2 ans
feature_st7565.md 37fba09021 ST7565 invert (#13237) il y a 5 ans
feature_stenography.md 786ebf8760 Remove requirement for `keymap_steno.h` include in keymaps (#22423) il y a 2 ans
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) il y a 3 ans
feature_tap_dance.md 2c70d38910 On-each-release tap dance function (#20255) il y a 3 ans
feature_tri_layer.md 6e6fff866e Fix typo in `docs/feature_tri_layer.md` (#22232) il y a 2 ans
feature_unicode.md 509a2b40b7 Fix old usage of UNICODE_MODE_MAC (#22238) il y a 2 ans
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) il y a 4 ans
feature_wpm.md 990ee8075e Fix typo in `feature_wpm.md` title (#20464) il y a 3 ans
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) il y a 4 ans
flashing.md a0ea7a6b17 feat, docs: WB32 flashing (#21217) il y a 3 ans
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) il y a 3 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 4 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 a4ed6ad0f5 Unicodemap keycodes rename (#21092) il y a 3 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 c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) il y a 2 ans
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) il y a 4 ans
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) il y a 3 ans
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 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 f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) il y a 3 ans
newbs_building_firmware_workflow.md 43ce7b0df5 [Docs] Highlight keymap name entry (#21138) il y a 3 ans
newbs_external_userspace.md 5501e804ff QMK Userspace (#22222) il y a 2 ans
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) il y a 3 ans
newbs_getting_started.md 8813bdf5dd Remove rosetta instructions for Apple Silicon (#22174) il y a 2 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 1ca34c2168 Fix VS code live share extension link (#21585) 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 3 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 b630df1aa7 Reword mention of personal keymaps from PR checklist (#22258) il y a 2 ans
qmk.css ccc87421e7 Some more tweaks to make everything look nice il y a 8 ans
qmk_custom_dark.css e3c6467ab9 [Docs] Improve contrast for warnings in dark mode (#21928) il y a 2 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 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) il y a 3 ans
quantum_painter.md 8e614250b4 [QP] Add support for OLED, variable framebuffer bpp (#19997) il y a 2 ans
quantum_painter_lvgl.md 169b0f33f6 Lvgl rate control (#22049) il y a 2 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 6 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 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) il y a 2 ans
reference_info_json.md e279c78ba3 Enable linking of encoders to switch within layout macros (#22264) il y a 2 ans
reference_keymap_extras.md 786ebf8760 Remove requirement for `keymap_steno.h` include in keymaps (#22423) il y a 2 ans
serial_driver.md e0c00c35ce Clarify PIO define is optional in docs. (#22339) il y a 2 ans
spi_driver.md c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) il y a 2 ans
squeezing_avr.md 2450fe28ee Add Imera converter (#22419) il y a 2 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 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 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 c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) il y a 2 ans
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) il y a 3 ans
unit_testing.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) il y a 2 ans
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores il y a 9 ans
ws2812_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) il y a 2 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.