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

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.