Strona główna Odkrywaj Pomoc
Zaloguj się
logic855
/
qmk_firmware
kopia lustrzana https://github.com/qmk/qmk_firmware.git
1
0
Forkuj 1
Pliki Problemy 0 Wiki
Drzewo: acb9cf12c4
Gałęzie Tagi
qmk_firmware
/
docs
yanekm 29ebb99b1f fixed link to Eclipse instructions (#9647) 6 lat temu
..
ChangeLog fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
de e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
es e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
fr-fr e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
gitbook 4580d3a730 RGB improvements (#1684) 9 lat temu
he-il e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
ja 4e4a3449a7 [Docs] Japanese translation of docs/compatible_microcontrollers.md (#9518) 6 lat temu
pt-br e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
ru-ru e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
zh-cn fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 lat temu
CNAME 4d26137e2a Create CNAME 8 lat temu
README.md 961477c791 make sure all our redirects are in order 6 lat temu
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 lat temu
_summary.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 lat temu
adc_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 lat temu
api_development_environment.md 99850aabca Add API documentation 6 lat temu
api_development_overview.md 99850aabca Add API documentation 6 lat temu
api_docs.md 99850aabca Add API documentation 6 lat temu
api_overview.md 99850aabca Add API documentation 6 lat temu
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 lat temu
breaking_changes.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
cli.md fcf150bd82 Streamline the macos install process 6 lat temu
cli_commands.md 751316c344 [CLI] Add a subcommand for getting information about a keyboard (#8666) 6 lat temu
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
coding_conventions_c.md f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717) 6 lat temu
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 lat temu
compatible_microcontrollers.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 lat temu
config_options.md 5c8b23ccff add SPLIT_HAND_MATRIX_GRID support (#8685) 6 lat temu
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 lat temu
contributing.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 lat temu
custom_quantum_functions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 lat temu
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) 6 lat temu
eeprom_driver.md 54b04d9665 Add SPI 25xx EEPROM support. (#8780) 6 lat temu
faq_build.md b9a38487f3 [Docs] Update udev rules to use TAG+="uaccess". (#8750) 6 lat temu
faq_debug.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 lat temu
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli 6 lat temu
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead 6 lat temu
feature_advanced_keycodes.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 lat temu
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 lat temu
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) 6 lat temu
feature_backlight.md 2c98c4dd4e Backlight docs wordsmithing (#9631) 6 lat temu
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) 6 lat temu
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 lat temu
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) 7 lat temu
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 lat temu
feature_debounce_type.md b8c3f4c60b quantum/debounce: Added sym_pk debounce algorithm (#8587) 6 lat temu
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) 6 lat temu
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) 6 lat temu
feature_encoders.md b7da69ec85 Adding information to feature_encoders.md (#9486) 6 lat temu
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 lat temu
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) 6 lat temu
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 lat temu
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
feature_layers.md 9ae8a45197 fixed the layer limit of LT() (#9492) 6 lat temu
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 lat temu
feature_leader_key.md 294cfd8d33 Delete trailing period in documentation (#9416) 6 lat temu
feature_led_matrix.md 24df54b807 Add documentation for led matrix 7 lat temu
feature_macros.md 02781979d6 [Docs] Improve Unicode documentation (#8676) 6 lat temu
feature_mouse_keys.md 3cd2a27ac0 Decouple mouse cursor and mouse wheel in accelerated mode (#6685) 6 lat temu
feature_oled_driver.md b5be96f8bb Adding OLED scroll setup functions (#8386) 6 lat temu
feature_pointing_device.md 573d1fbb92 Include `pointing_device_send` in docs (#9185) 6 lat temu
feature_ps2_mouse.md b7dc2eb9ab Add movement hook to ps2_mouse (#8805) 6 lat temu
feature_rawhid.md d1df576ece Allow for overriding RAW endpoint usage page and ID. (#8834) 6 lat temu
feature_rgb_matrix.md 98642ca028 Improve keycode handling for RGB (#7677) 6 lat temu
feature_rgblight.md 98642ca028 Improve keycode handling for RGB (#7677) 6 lat temu
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 lat temu
feature_split_keyboard.md 5c8b23ccff add SPLIT_HAND_MATRIX_GRID support (#8685) 6 lat temu
feature_stenography.md b272c035ba [Docs] Random Fixes (#8340) 6 lat temu
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) 6 lat temu
feature_tap_dance.md 1a159a38ed Clean up Tap Dance docs (#9372) 6 lat temu
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 7 lat temu
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 lat temu
feature_unicode.md 02781979d6 [Docs] Improve Unicode documentation (#8676) 6 lat temu
feature_userspace.md 2543bad250 [Docs] Fixed the hyperlink to `/users/_example/`. (#9326) 6 lat temu
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 lat temu
feature_wpm.md bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) 6 lat temu
flashing.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 lat temu
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 lat temu
fuse.txt ca01d94005 convert docs to lowercase and underscores 9 lat temu
getting_started_docker.md 0fbcb41c85 Reintegrate previous docker docs (#9084) 6 lat temu
getting_started_github.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 lat temu
getting_started_make_guide.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 lat temu
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 lat temu
hand_wire.md 961477c791 make sure all our redirects are in order 6 lat temu
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) 6 lat temu
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 lat temu
hardware_keyboard_guidelines.md dc98d44582 [Docs] added the description of the reading order of the rules.mk files. (#8566) 6 lat temu
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc 6 lat temu
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 lat temu
i2c_driver.md b272c035ba [Docs] Random Fixes (#8340) 6 lat temu
index.html e182a38e7c Add redirect for old getting started links (#8987) 6 lat temu
internals_defines.md ae7284edb8 rename api docs to internals 8 lat temu
internals_gpio_control.md d26a14c169 add 'togglePin' convenience function (#8734) 6 lat temu
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 lat temu
internals_midi_device.md ae7284edb8 rename api docs to internals 8 lat temu
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 lat temu
internals_midi_util.md ae7284edb8 rename api docs to internals 8 lat temu
internals_send_functions.md ae7284edb8 rename api docs to internals 8 lat temu
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 lat temu
isp_flashing_guide.md f66850bfd0 Improve stock bootloader list (#9067) 6 lat temu
keycodes.md 3736db6081 Add OS compatibility matrix for basic keycodes (#8557) 6 lat temu
keycodes_basic.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 lat temu
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 lat temu
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 lat temu
mod_tap.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) 6 lat temu
newbs.md 45e218ceec overhaul the newbs guide 6 lat temu
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section 6 lat temu
newbs_flashing.md 9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 6 lat temu
newbs_getting_started.md 32340e14fb Update newbs MSYS2 pacman instructions (#9445) 6 lat temu
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 lat temu
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 lat temu
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 lat temu
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
newbs_learn_more_resources.md 45e218ceec overhaul the newbs guide 6 lat temu
newbs_testing_debugging.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
one_shot_keys.md 8e0af2f5ba [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380) 6 lat temu
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) 6 lat temu
other_vscode.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
platformdev_chibios_earlyinit.md 05e9ff6554 Add support for hardware and board initialisation overrides. (#8330) 6 lat temu
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 lat temu
power.txt bb53635f33 Trim trailing whitespace 8 lat temu
proton_c_conversion.md 6d84795bc1 Update ARM split keyboard docs (#9160) 6 lat temu
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 lat temu
qmk_custom_dark.css 1b267d4840 Fix darkmode (#8393) 6 lat temu
qmk_custom_light.css 1b267d4840 Fix darkmode (#8393) 6 lat temu
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
redirects.json d569f08771 Configuration system for CLI (#6708) 7 lat temu
ref_functions.md 750179e111 Fix a couple of typos that were causing confusion (#8767) 6 lat temu
reference_configurator_support.md d5f34c4810 Polish Configurator section 6 lat temu
reference_glossary.md 29ebb99b1f fixed link to Eclipse instructions (#9647) 6 lat temu
reference_info_json.md bcb1815420 Add label to the info.json reference 7 lat temu
reference_keymap_extras.md 9b85bd68a4 feat: add dvorak-fr as extra keymap (#9512) 6 lat temu
serial_driver.md 6d84795bc1 Update ARM split keyboard docs (#9160) 6 lat temu
spi_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 lat temu
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
sw.js 303f425c6b Fix up info boxes. 8 lat temu
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 lat temu
tap_hold.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 lat temu
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) 6 lat temu
unit_testing.md e02a3c559d Edit Unit Testing Documentation (#8961) 6 lat temu
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 lat temu
ws2812_driver.md 18e561b82c Fix incorrect delay when setting WS2812 (and similar) leds (#9302) 6 lat temu

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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

Totally new to QMK? There are two ways to get started:

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.