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: 38cd3684e1
Branches Tags
qmk_firmware
/
docs
Albert Y 300dab7962 [Code] Add solid reactive gradient mode (#17228) il y a 4 ans
..
ChangeLog d0af56da33 Breaking changes for 2022q2. (#17221) il y a 4 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 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) il y a 4 ans
zh-cn 0da6562c4d Make default layer size 16-bit (#15286) il y a 4 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 82f0263e41 Merge remote-tracking branch 'origin/master' into develop il y a 4 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 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) il y a 4 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 b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
breaking_changes.md 89a5d5aea0 Fixup command sequencing for master/develop. (#17227) il y a 4 ans
breaking_changes_history.md de6360feca stub changelog 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 59e28b8958 Add cli command to import keyboard|keymap|kbfirmware (#16668) il y a 4 ans
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) il y a 6 ans
cli_development.md da6d6ce2e1 Some docs improvements (#15845) il y a 4 ans
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) il y a 4 ans
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) il y a 4 ans
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) il y a 4 ans
config_options.md 3b9e186019 Do not enable PERMISSIVE_HOLD when TAPPING_TERM exceeds 500ms (#15674) il y a 4 ans
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) il y a 5 ans
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) il y a 4 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 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) il y a 4 ans
data_driven_config.md ace0603f4f Change data driven "str" type to represent a quoted string literal (#16516) il y a 4 ans
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) il y a 6 ans
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 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 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) il y a 4 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 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) il y a 4 ans
feature_advanced_keycodes.md 8153b55e07 Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md (#17211) il y a 4 ans
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) il y a 5 ans
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) il y a 4 ans
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) il y a 4 ans
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) il y a 4 ans
feature_caps_word.md 68b16bba68 [Core] Add Caps Word feature to core (#16588) il y a 4 ans
feature_combo.md 21958a9343 New combo configuration options (#15083) il y a 4 ans
feature_command.md a03aa301de Remove Full Bootmagic (#13846) il y a 5 ans
feature_converters.md 36c2575658 Grammar fixes for docs/feature_converters.md (#17652) il y a 4 ans
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) il y a 4 ans
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 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 9dc7b9d40c Added Wait time to sending each Keys for Dynamic Macros function (#16800) il y a 4 ans
feature_encoders.md d0af56da33 Breaking changes for 2022q2. (#17221) il y a 4 ans
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) il y a 4 ans
feature_haptic_feedback.md f090881aeb [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) il y a 4 ans
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) il y a 4 ans
feature_joystick.md c05e8afe45 Joystick feature updates (#16732) il y a 4 ans
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) il y a 4 ans
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) il y a 4 ans
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) il y a 4 ans
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 ans
feature_leader_key.md b1f8622513 [Docs] Update feature_leader_key.md (#16344) il y a 4 ans
feature_led_indicators.md a5a4597311 Refine LED indicator documentation (#16304) il y a 4 ans
feature_led_matrix.md f296e1d1e2 [Docs] Align LED Matrix docs with RGB matrix docs (#17140) il y a 4 ans
feature_macros.md 3ecb0a80af Feature-ify Send String (#17275) il y a 4 ans
feature_midi.md 026d0e8bf1 Update feature_midi.md (#17390) il y a 4 ans
feature_mouse_keys.md c725b6bf89 [Core] Mouse key kinetic mode fix (#17176) il y a 4 ans
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) il y a 4 ans
feature_pointing_device.md 3c58f98929 [Core] PMW33XX drivers overhaul (#17613) il y a 4 ans
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) il y a 4 ans
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 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 300dab7962 [Code] Add solid reactive gradient mode (#17228) il y a 4 ans
feature_rgblight.md 5841c755ae rgblight: Add functions to stop blinking one or all but one layer (#16859) il y a 4 ans
feature_secure.md 2a3dd95229 Add basic secure docs (#17577) il y a 4 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) il y a 5 ans
feature_split_keyboard.md 1204cbb7ea Update feature_split_keyboard.md to add extra detail about left and right matrices. (#17492) il y a 4 ans
feature_st7565.md 37fba09021 ST7565 invert (#13237) il y a 5 ans
feature_stenography.md 7060cb7b26 Refactor steno and add `STENO_PROTOCOL = [all|txbolt|geminipr]` (#17065) 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 1706da9054 tap-dance: Restructure code and document in more detail (#16394) il y a 4 ans
feature_thermal_printer.md 4c675a83ba Format keycode tables il y a 8 ans
feature_unicode.md f634fddd34 Remove `send_unicode_hex_string()` (#16518) il y a 4 ans
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) il y a 4 ans
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) il y a 4 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 d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) il y a 4 ans
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) il y a 5 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 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) il y a 5 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 871eeae4ea PoC: Swap Escape and Caps (#16336) il y a 4 ans
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) il y a 4 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 da6d6ce2e1 Some docs improvements (#15845) il y a 4 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 d3584be431 [Docs] Update newbs_building_firmware.md (#16333) il y a 4 ans
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) il y a 5 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 8901c9eca1 Add Atom editor suggestion (#15969) 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_chibios_earlyinit.md bbab8eb993 Make bootloader_jump for dualbank STM32 respect STM32_BOOTLOADER_DUAL_BANK_DELAY (#17178) il y a 4 ans
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) il y a 4 ans
platformdev_rp2040.md 5846b40f74 RP2040 emulated EEPROM. (#17519) il y a 4 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 26954bbc28 [Docs] Add Encoder requirements to PR Checklist doc (#17634) il y a 4 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 787a68948f [Core] Add Reboot keycode to core (#15990) il y a 4 ans
quantum_painter.md b67ae67687 [QP] Add ILI9488 support. (#17438) il y a 4 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 71472a1692 Update ref_functions.md (replaced deprecated `RESET`) (#17436) il y a 4 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 82f0263e41 Merge remote-tracking branch 'origin/master' into develop il y a 4 ans
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) il y a 4 ans
serial_driver.md d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) il y a 4 ans
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop il y a 5 ans
squeezing_avr.md b1681fb6a1 [Core] Allow usage of AVRs minimal printf library (#16266) 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 8f585153c4 Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) il y a 4 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 8545473307 Removes terminal from QMK. (#17258) il y a 4 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 d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) il y a 4 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.