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: 81a6407dca
Branches Tags
qmk_firmware
/
docs
QMK Bot 5dabc1b387 Merge remote-tracking branch 'origin/master' into develop il y a 3 ans
..
ChangeLog 4d33f356a6 Macro keycode name refactoring (#18958) 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 eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop il y a 3 ans
zh-cn 4d33f356a6 Macro keycode name refactoring (#18958) 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 5233c69bc6 Remove thermal printer. (#18959) il y a 3 ans
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) il y a 5 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 5e4b076af3 Remove legacy keycodes, part 5 (#18710) 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 9b5b072255 2022q3 Changelog. (#18180) il y a 4 ans
breaking_changes_history.md 9b5b072255 2022q3 Changelog. (#18180) il y a 4 ans
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) il y a 6 ans
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) il y a 4 ans
cli.md fcf150bd82 Streamline the macos install process il y a 6 ans
cli_commands.md 959f4cbb62 docs: some typos (#18582) 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 5dabc1b387 Merge remote-tracking branch 'origin/master' into develop 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 4d33f356a6 Macro keycode name refactoring (#18958) 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 f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) il y a 4 ans
custom_matrix.md 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) il y a 4 ans
custom_quantum_functions.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 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 fc394dfdd4 [Docs] Fix link to keyboard layout editor (#18801) 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 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 3 ans
feature_advanced_keycodes.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) il y a 3 ans
feature_audio.md 69fa02c37d Align audio keycode names (#18962) il y a 3 ans
feature_auto_shift.md 22be7e79ac Normalise Auto Shift keycodes (#18892) il y a 3 ans
feature_autocorrect.md 2ff1d85290 Normalise Autocorrect keycodes (#18893) 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 a80b886751 Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) il y a 3 ans
feature_combo.md efe520645e Normalise Combo keycodes (#18877) il y a 3 ans
feature_command.md a03aa301de Remove Full Bootmagic (#13846) il y a 5 ans
feature_converters.md a42ab90220 Add Bonsai C4 as a platform board file (#18901) il y a 3 ans
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) il y a 4 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 fe18df9d41 Normalise Dynamic Macro keycodes (#18939) il y a 3 ans
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) il y a 3 ans
feature_encoders.md a4d1d8b745 Resolve conflict merging master to develop (#18297) il y a 4 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 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 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 1d34f380eb Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` (#18843) il y a 3 ans
feature_layers.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 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 b33fc34967 Deprecate `KC_LEAD` for `QK_LEAD` (#18792) il y a 3 ans
feature_led_indicators.md cbe1c22d46 quantum: led: split out led_update_ports() for customization of led behaviour (#14452) il y a 3 ans
feature_led_matrix.md 219afaba42 Reworked backlight keycodes. (#18961) il y a 3 ans
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) il y a 3 ans
feature_midi.md 8b658dcc9a Normalise MIDI keycodes (#18972) 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 959f4cbb62 docs: some typos (#18582) il y a 3 ans
feature_pointing_device.md 94d5fe6f90 Allow Active High for Pointing Device Motion Pin (#18404) 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 9d717c85dc Merge remote-tracking branch 'upstream/master' into develop il y a 3 ans
feature_rgblight.md 18dc851e37 Remove legacy Debug keycode (#18769) 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 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) il y a 5 ans
feature_space_cadet.md 002b58f0e4 Normalise Space Cadet keycodes (#18864) il y a 3 ans
feature_split_keyboard.md c347e732be Remove legacy EEPROM clear keycodes (#18782) il y a 3 ans
feature_st7565.md 37fba09021 ST7565 invert (#13237) il y a 5 ans
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) il y a 4 ans
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) il y a 4 ans
feature_tap_dance.md 269600f640 Update feature_tap_dance.md (#18509) il y a 3 ans
feature_unicode.md 5974d989fe Normalise Unicode keycodes (#18898) 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 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 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 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
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) il y a 4 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 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) il y a 4 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 94755308e0 Fix anchors with <code> in table of content (#15169) 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 4de3f53984 Merge remote-tracking branch 'origin/master' into develop il y a 3 ans
keycodes_basic.md a26f1ddafa Chromeos keycodes (#18212) il y a 3 ans
keycodes_magic.md 871eeae4ea PoC: Swap Escape and Caps (#16336) il y a 4 ans
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) il y a 4 ans
keymap.md 4b2d71de52 Remove legacy international keycodes (#18588) il y a 3 ans
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) il y a 4 ans
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
newbs_building_firmware.md 51f2d27321 Fix typo (#18526) 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 64acbcb42a [Docs] Building with GitHub Userspace (#16271) il y a 4 ans
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) il y a 4 ans
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) il y a 4 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 b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) il y a 5 ans
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) il y a 4 ans
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) il y a 4 ans
platformdev_blackpill_f4x1.md dbce41cb6b [Docs] Update platformdev_blackpill_f411.md (#18666) 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 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 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 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) il y a 4 ans
power.txt bb53635f33 Trim trailing whitespace il y a 8 ans
pr_checklist.md dc7d2692c6 Grammar Fix for PR Checklist (#18540) 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 9daf77b593 Add raw output option for QGF/QFF files. (#18998) 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 00dc764f72 [docs] Improve documentation regarding info.json (#18508) 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 40aa9c8745 spelling fix (#18831) 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 fb6e821541 Add Elite-Pi converter (#18236) il y a 4 ans
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) il y a 6 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 fd4c3f46fb Align dynamic tapping term keycode names (#18963) 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 5233c69bc6 Remove thermal printer. (#18959) 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 27dec8d16d [Core] Allow custom timings for WS2812 PIO driver (#18006) 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.