Начало Каталог Помощ
Вход
logic855
/
qmk_firmware
огледало от https://github.com/qmk/qmk_firmware.git
1
0
Разклонения 1
Файлове Задачи 0 Уики
ИН на ревизия: 9d1d875a95
Клонове Маркери
qmk_firmware
/
docs
moritz-john 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) преди 5 години
..
ChangeLog 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) преди 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 72f9c4c0d3 [Docs] Japanese translation of internals_*.md (#10316) преди 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 4e8166750b Small tweaks to docs to make them more user friendly (#11518) преди 5 години
adc_driver.md 8a4a0c25fd Change analogRead calls to analogReadPin (#9023) преди 6 години
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 години
breaking_changes.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) преди 6 години
cli.md fcf150bd82 Streamline the macos install process преди 6 години
cli_commands.md d9785ec313 Improve the compile and flash subcommands (#11334) преди 5 години
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) преди 6 години
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) преди 6 години
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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
config_options.md 501f2fdef1 Normalise include statements in core code (#11153) преди 5 години
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) преди 5 години
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 c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 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 d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) преди 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 0cb7133e0d Doc followup 9942 (#10473) преди 6 години
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) преди 7 години
feature_auto_shift.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
feature_backlight.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 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) преди 5 години
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) преди 7 години
feature_debounce_type.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) преди 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) преди 7 години
feature_haptic_feedback.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 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 61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) преди 6 години
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) преди 7 години
feature_leader_key.md 294cfd8d33 Delete trailing period in documentation (#9416) преди 6 години
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) преди 5 години
feature_led_matrix.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
feature_macros.md 3300164065 Typo fix: Useful function -> Useful Functions (#11342) преди 5 години
feature_mouse_keys.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
feature_oled_driver.md c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
feature_pointing_device.md 780ca5565d Improve Pointing Device report sending (#11064) преди 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
feature_rgblight.md bad9592a18 Add rgblight_reload_from_eeprom() (#11411) преди 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 16d55b14b7 [Docs] Add VBUS hack for teensys (#10986) преди 5 години
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) преди 6 години
feature_tap_dance.md 9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259) преди 6 години
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) преди 6 години
feature_thermal_printer.md 4c675a83ba Format keycode tables преди 8 години
feature_unicode.md b5c2e5e8fd Fix documentation so UCIS example compiles. (#11541) преди 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 bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) преди 6 години
flashing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 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 0fbcb41c85 Reintegrate previous docker docs (#9084) преди 6 години
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 944cf6476e Update docs/getting_started_make_guide.md (#11373) преди 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 346bfb2a05 Update i2c_driver.md (#10131) преди 6 години
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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 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 4e8166750b Small tweaks to docs to make them more user friendly (#11518) преди 5 години
newbs_getting_started.md 162842f16e [Docs] add qmk setup home parameter (#11451) преди 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 078586b21a Update one_shot_keys.md (#10917) преди 5 години
other_eclipse.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) преди 5 години
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 94e94ffb5b Recommend use of LED Indicator config (#10895) преди 5 години
proton_c_conversion.md 6d84795bc1 Update ARM split keyboard docs (#9160) преди 6 години
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 2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370) преди 6 години
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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) преди 5 години
reference_keymap_extras.md ca8df55858 Added mac variant of portuguese keymap extras (#11260) преди 5 години
serial_driver.md 6d84795bc1 Update ARM split keyboard docs (#9160) преди 6 години
spi_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) преди 6 години
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 c66df16644 2020 November 28 Breaking Changes Update (#11053) преди 5 години
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) преди 6 години
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) преди 6 години
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 3d70766327 Add BGR byte order for WS2812 drivers (#11562) преди 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.