Home Esplora Aiuto
Accedi
logic855
/
qmk_firmware
mirror da https://github.com/qmk/qmk_firmware.git
1
0
Forka 1
File Problemi 0 Wiki
Albero (Tree): 047ef3cd12
Rami (Branch) Tag
qmk_firmware
/
docs
leviport 3502bbbd16 Fix typo in docs/ref_functions.md (#16690) 4 anni fa
..
ChangeLog cf31355f08 Changelog 2022q1 (#16380) 4 anni fa
gitbook 4580d3a730 RGB improvements (#1684) 9 anni fa
ja 0880850b15 [Bug] Rename has_mouse_report_changed parameters (#16417) 4 anni fa
zh-cn 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 anni fa
CNAME 4d26137e2a Create CNAME 8 anni fa
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 anni fa
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 anni fa
_summary.md cf31355f08 Changelog 2022q1 (#16380) 4 anni fa
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 anni fa
api_development_environment.md 99850aabca Add API documentation 6 anni fa
api_development_overview.md 99850aabca Add API documentation 6 anni fa
api_docs.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 anni fa
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
breaking_changes.md cf31355f08 Changelog 2022q1 (#16380) 4 anni fa
breaking_changes_history.md cf31355f08 Changelog 2022q1 (#16380) 4 anni fa
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 anni fa
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 anni fa
cli.md fcf150bd82 Streamline the macos install process 6 anni fa
cli_commands.md 2e279f1b88 Initial pass at data driven new-keyboard subcommand (#12795) 4 anni fa
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 anni fa
cli_development.md da6d6ce2e1 Some docs improvements (#15845) 4 anni fa
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) 4 anni fa
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 4 anni fa
compatible_microcontrollers.md 77062e9a36 Add L432, L442. (#16016) 4 anni fa
config_options.md a2ffdb4abd Merge remote-tracking branch 'upstream/master' into develop 4 anni fa
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 anni fa
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 4 anni fa
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 anni fa
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 anni fa
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 anni fa
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 anni fa
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 anni fa
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
custom_quantum_functions.md 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) 4 anni fa
data_driven_config.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 anni fa
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 anni fa
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 anni fa
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 anni fa
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 anni fa
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
faq_debug.md 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 4 anni fa
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 anni fa
faq_keymap.md f529580860 Basic keycode overhaul (#14726) 4 anni fa
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 anni fa
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 anni fa
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 anni fa
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 anni fa
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) 4 anni fa
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 anni fa
feature_combo.md 21958a9343 New combo configuration options (#15083) 4 anni fa
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 anni fa
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 anni fa
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 anni fa
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 anni fa
feature_encoders.md f662939037 Sentence structure update (#16306) 4 anni fa
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 anni fa
feature_haptic_feedback.md 1d11ae3087 Rip out old macro and action_function system (#16025) 4 anni fa
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 anni fa
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) 4 anni fa
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 anni fa
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 anni fa
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
feature_leader_key.md b1f8622513 [Docs] Update feature_leader_key.md (#16344) 4 anni fa
feature_led_indicators.md 3e5cb1da0f Improve description of LED state data sync option (#16302) 4 anni fa
feature_led_matrix.md 0452ad9479 Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989) 4 anni fa
feature_macros.md f52cc210b8 [Docs] feature_macro.md: minor formatting fix (#16205) 4 anni fa
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
feature_mouse_keys.md 80dbdb2a61 Merge remote-tracking branch 'origin/master' into develop 4 anni fa
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) 4 anni fa
feature_pointing_device.md 86b123141b docs: fix code sample (#16623) 4 anni fa
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 5 anni fa
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 4 anni fa
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
feature_rgb_matrix.md 29ab430f1f [Docs] Anchor link correction in rgb matrix docs (#16460) 4 anni fa
feature_rgblight.md 259cf76966 Link WS2812 driver page from rgb feature docs (#16366) 4 anni fa
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 anni fa
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
feature_split_keyboard.md 43d18321e3 Merge remote-tracking branch 'origin/master' into develop 4 anni fa
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 anni fa
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop 4 anni fa
feature_swap_hands.md d8324e8a9c Document swap-hands tap-toggle feature (#15229) 4 anni fa
feature_tap_dance.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 7 anni fa
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 anni fa
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 anni fa
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 anni fa
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 anni fa
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 anni fa
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 anni fa
flashing.md 97d0e7cb2d [Docs] Add commands to flashing docs (#16456) 4 anni fa
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 anni fa
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 5 anni fa
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 anni fa
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 4 anni fa
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 anni fa
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 5 anni fa
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 anni fa
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) 5 anni fa
index.html 16767312db Align docs to new-keyboard behaviour (#16357) 4 anni fa
internals_defines.md ae7284edb8 rename api docs to internals 8 anni fa
internals_gpio_control.md 6e40dfa022 Add open-drain GPIO support. (#15282) 4 anni fa
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 anni fa
internals_midi_device.md ae7284edb8 rename api docs to internals 8 anni fa
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 anni fa
internals_midi_util.md ae7284edb8 rename api docs to internals 8 anni fa
internals_send_functions.md ae7284edb8 rename api docs to internals 8 anni fa
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 anni fa
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 4 anni fa
keycodes.md b45a037c7e Rename some Quantum keycodes (#15968) 4 anni fa
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 anni fa
keycodes_magic.md 2726856cde Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 4 anni fa
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
keymap.md da6d6ce2e1 Some docs improvements (#15845) 4 anni fa
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 anni fa
newbs_building_firmware.md d3584be431 [Docs] Update newbs_building_firmware.md (#16333) 4 anni fa
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 anni fa
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) 4 anni fa
newbs_getting_started.md 96b6ddf4bf fixed typo in docs/newbs_getting_started.md (#16501) 4 anni fa
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 anni fa
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 anni fa
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) 5 anni fa
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 anni fa
newbs_learn_more_resources.md 8901c9eca1 Add Atom editor suggestion (#15969) 4 anni fa
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 anni fa
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 anni fa
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
other_vscode.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 anni fa
platformdev_chibios_earlyinit.md 5fb93934d0 Fixes for bootloader refactor build failures (#15638) 4 anni fa
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 anni fa
porting_your_keyboard_to_qmk.md 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) 4 anni fa
power.txt bb53635f33 Trim trailing whitespace 8 anni fa
pr_checklist.md 61ba8efa3e Update pr_checklist.md (#16484) 4 anni fa
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 anni fa
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 anni fa
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 anni fa
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 anni fa
quantum_keycodes.md b45a037c7e Rename some Quantum keycodes (#15968) 4 anni fa
redirects.json d569f08771 Configuration system for CLI (#6708) 7 anni fa
ref_functions.md 3502bbbd16 Fix typo in docs/ref_functions.md (#16690) 4 anni fa
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 anni fa
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 anni fa
reference_info_json.md 8014fb14b6 Fix in-page links in reference_info_json.md (#16487) 4 anni fa
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 anni fa
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 anni fa
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 anni fa
squeezing_avr.md e01307f265 Typo in squeezing_avr.md (#16506) 4 anni fa
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 anni fa
sw.js 303f425c6b Fix up info boxes. 8 anni fa
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 anni fa
tap_hold.md 6c40b6856b [Docs] Include ASCII diagram to explain tap-hold modes (#15873) 4 anni fa
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 anni fa
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 anni fa
understanding_qmk.md da6d6ce2e1 Some docs improvements (#15845) 4 anni fa
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 5 anni fa
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 anni fa
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) 4 anni fa

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.