Начало Каталог Помощ
Вход
logic855
/
qmk_firmware
огледало от https://github.com/qmk/qmk_firmware.git
1
0
Разклонения 1
Файлове Задачи 0 Уики
Клон: python_optimizations
Клонове Маркери
qmk_firmware
/
docs
QMK Bot 8d30209260 Merge remote-tracking branch 'origin/master' into develop преди 5 години
..
ChangeLog 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) преди 5 години
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
fr-fr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
gitbook 4580d3a730 RGB improvements (#1684) преди 9 години
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
ja 8db1be6420 [Docs] Update Japanese getting started documents. (#12806) преди 5 години
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
.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 10e8ed7430 [Docs] add README translation in portuguese (#7016) преди 6 години
_summary.md b2fdd48744 Add ST7565 LCD driver (#13089) преди 5 години
adc_driver.md 65c9752762 Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) преди 5 години
api_development_environment.md 99850aabca Add API documentation преди 6 години
api_development_overview.md 99850aabca Add API documentation преди 6 години
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
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 c80e5f9f88 Audio system overhaul (#11820) преди 5 години
breaking_changes.md e3030bff5e Merge remote-tracking branch 'upstream/master' into develop преди 5 години
breaking_changes_history.md 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) преди 5 години
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) преди 6 години
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) преди 5 години
cli.md fcf150bd82 Streamline the macos install process преди 6 години
cli_commands.md 7a25dcacff New command: qmk console (#12828) преди 5 години
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) преди 6 години
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) преди 6 години
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) преди 5 години
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) преди 6 години
compatible_microcontrollers.md 9cf82fae95 Add STM32L433 and L443 support (#12063) преди 5 години
config_options.md 172e6a7030 Extensible split data sync (#11930) преди 5 години
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) преди 6 години
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) преди 6 години
configurator_troubleshooting.md d5f34c4810 Polish Configurator section преди 6 години
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) преди 6 години
custom_quantum_functions.md f287597c19 Use single memcmp to determine if matrix changed. (#13064) преди 5 години
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) преди 5 години
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 10096fc42e Zadig docs: add APM32 device name (#11356) преди 5 години
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) преди 5 години
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
faq_debug.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) преди 5 години
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) преди 5 години
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
feature_advanced_keycodes.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) преди 5 години
feature_audio.md 2538d341d8 Document user song list file (#13101) преди 5 години
feature_auto_shift.md c02137a0d2 Add Per Key functionality for AutoShift (#11536) преди 5 години
feature_backlight.md 06aea834c4 Backlight: add defines for default level and breathing state (#12560) преди 5 години
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) преди 6 години
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) преди 6 години
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) преди 6 години
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) преди 7 години
feature_debounce_type.md a0959f1b33 Add asym_eager_defer_pk debounce type (#12689) преди 5 години
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) преди 6 години
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) преди 6 години
feature_encoders.md a0fed0ea17 Convert Encoder callbacks to be boolean functions (#12805) преди 5 години
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) преди 7 години
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) преди 5 години
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) преди 6 години
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers преди 6 години
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) преди 5 години
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) преди 7 години
feature_leader_key.md 26b9b3aa23 feat: infinite timeout for leader key (#6580) преди 5 години
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) преди 5 години
feature_led_matrix.md 875bb48a20 Top level heading for common config (LED Matrix) (#13153) преди 5 години
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) преди 5 години
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) преди 5 години
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) преди 5 години
feature_oled_driver.md 0311c8036d Add oled_invert (#13172) преди 5 години
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop преди 5 години
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) преди 5 години
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) преди 5 години
feature_rgb_matrix.md a61c38c7ec Merge remote-tracking branch 'origin/master' into develop преди 5 години
feature_rgblight.md de8fada3a3 Merge remote-tracking branch 'origin/master' into develop преди 5 години
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 172e6a7030 Extensible split data sync (#11930) преди 5 години
feature_st7565.md 37fba09021 ST7565 invert (#13237) преди 5 години
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
feature_swap_hands.md f0b30e0027 Make Swap Hands use PROGMEM (#12284) преди 5 години
feature_tap_dance.md 653ecf91c2 More Tap Dance docs improvements (#12358) преди 5 години
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) преди 7 години
feature_thermal_printer.md 4c675a83ba Format keycode tables преди 8 години
feature_unicode.md 04ab5de73c Deprecate `send_unicode_hex_string()` (#12602) преди 5 години
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) преди 5 години
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) преди 7 години
feature_wpm.md 180a32ec59 Enhancement of WPM feature (#11727) преди 5 години
flashing.md 891d18d356 Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600) преди 5 години
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) преди 6 години
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) преди 5 години
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) преди 5 години
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) преди 6 години
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) преди 5 години
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) преди 6 години
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) преди 6 години
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) преди 5 години
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) преди 5 години
internals_defines.md ae7284edb8 rename api docs to internals преди 8 години
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
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 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) преди 5 години
keycodes.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) преди 5 години
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) преди 5 години
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) преди 6 години
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) преди 6 години
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) преди 5 години
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers преди 6 години
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) преди 5 години
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) преди 5 години
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) преди 5 години
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 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) преди 6 години
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers преди 6 години
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) преди 5 години
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) преди 5 години
one_shot_keys.md c00a9937f2 [Docs] Update one_shot_keys.md (#12291) преди 5 години
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) преди 5 години
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) преди 6 години
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) преди 5 години
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) преди 6 години
power.txt bb53635f33 Trim trailing whitespace преди 8 години
pr_checklist.md 6b5e349d7e Add additional info to PR Checklist (#12630) преди 5 години
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 54c58ea6de Add explicit id tags to externally linked headers преди 6 години
redirects.json d569f08771 Configuration system for CLI (#6708) преди 7 години
ref_functions.md bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) преди 5 години
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop преди 5 години
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) преди 5 години
serial_driver.md d9610120de Add Full-duplex serial driver for ARM boards (#9842) преди 5 години
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop преди 5 години
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) преди 6 години
sw.js 303f425c6b Fix up info boxes. преди 8 години
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) преди 6 години
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) преди 5 години
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) преди 6 години
uart_driver.md 30b46fad57 UART driver refactor (#11637) преди 5 години
understanding_qmk.md d1806a26e4 Split transport mirror (#11046) преди 5 години
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores преди 9 години
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) преди 5 години

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.