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: 83e978da1f
Gałęzie Tagi
qmk_firmware
/
docs
QMK Bot 5c6a8f599f Merge remote-tracking branch 'origin/master' into develop 4 lat temu
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) 5 lat temu
de 596c4a1f87 Remove bin/qmk (#14231) 5 lat temu
es b2a186cf92 Purge uGFX. (#14720) 4 lat temu
fr-fr b2a186cf92 Purge uGFX. (#14720) 4 lat temu
gitbook 4580d3a730 RGB improvements (#1684) 9 lat temu
he-il b2a186cf92 Purge uGFX. (#14720) 4 lat temu
ja 9a20bc1f8f Merge remote-tracking branch 'origin/master' into develop 4 lat temu
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 lat temu
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 lat temu
ru-ru b2a186cf92 Purge uGFX. (#14720) 4 lat temu
zh-cn b2a186cf92 Purge uGFX. (#14720) 4 lat temu
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 lat temu
CNAME 4d26137e2a Create CNAME 8 lat temu
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 lat temu
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 lat temu
_summary.md 83988597f4 Add Support for USB programmable buttons (#12950) 4 lat temu
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 lat temu
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 lat temu
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 lat temu
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 lat temu
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) 5 lat temu
cli.md fcf150bd82 Streamline the macos install process 6 lat temu
cli_commands.md 590b405468 New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) 4 lat temu
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 lat temu
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 lat temu
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 lat temu
compatible_microcontrollers.md 1a9e7b95ab Change `MK66F18` -> `MK66FX1M0` (#14659) 4 lat temu
config_options.md 02ab7b1888 [Core] Fix "6kro enable" and clarify naming (#14563) 4 lat temu
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 lat temu
configurator_default_keymaps.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 lat temu
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 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 596c4a1f87 Remove bin/qmk (#14231) 5 lat temu
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
custom_quantum_functions.md 45f88af4a1 [Docs] update suspend_*_user examples (#14542) 4 lat temu
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 lat temu
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 lat temu
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
driver_installation_zadig.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 lat temu
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 5 lat temu
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 lat temu
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
faq_debug.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 lat temu
faq_keymap.md bb356a1584 [Docs] Update path to keycode.h (#14263) 5 lat temu
faq_misc.md d8f0c8783a Remove sysex API (#14723) 4 lat temu
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 lat temu
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 lat temu
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 lat temu
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_bluetooth.md db41a3426c Improve Adafruit BLE configuration defines (#14749) 4 lat temu
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) 5 lat temu
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) 5 lat temu
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 lat temu
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 5 lat temu
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 lat temu
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 lat temu
feature_encoders.md 19e33b685f [Docs] Modify encoder_update_user example to return false (#14541) 4 lat temu
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 lat temu
feature_haptic_feedback.md eb5b24f97c Add LM() keys to the list of keys disabled by NO_HAPTIC_MOD (#14181) 4 lat temu
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 lat temu
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
feature_key_overrides.md 1e7117317f Documentation: Fix links in key overrides (#14228) 5 lat temu
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 lat temu
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 lat temu
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 lat temu
feature_led_matrix.md ddb6821b97 [Docs] fix wrong directory for RGB Matrix animations (#14494) 4 lat temu
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 lat temu
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 lat temu
feature_oled_driver.md 657323a206 [Docs] fixed incorrect amount of steps for oled usage (#13519) 4 lat temu
feature_pointing_device.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 4 lat temu
feature_ps2_mouse.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_rgb_matrix.md c38a730805 Merge remote-tracking branch 'upstream/master' into develop 4 lat temu
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) 5 lat temu
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 lat temu
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
feature_split_keyboard.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 lat temu
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 lat temu
feature_stenography.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_swap_hands.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
feature_tap_dance.md 13f3e30e86 Fix link from feature_tap_dance.md to tapping term settings (#14741) 4 lat temu
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 lat temu
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 lat temu
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 lat temu
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 lat temu
feature_velocikey.md 8a8fdd9a72 Highlight keycode (#14317) 5 lat temu
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) 5 lat temu
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 lat temu
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 lat temu
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 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 d8f0c8783a Remove sysex API (#14723) 4 lat temu
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 lat temu
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 lat temu
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 lat temu
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) 4 lat temu
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 4 lat temu
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) 4 lat temu
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 lat temu
internals_defines.md ae7284edb8 rename api docs to internals 8 lat temu
internals_gpio_control.md c8b00b2e91 Update documentation because GPIO functions are no longer in quantum.h (#14826) 4 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 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 lat temu
keycodes.md 83988597f4 Add Support for USB programmable buttons (#12950) 4 lat temu
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 lat temu
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 5 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 27d9579fd5 Document examples on intercepting Mod-Tap (#14502) 4 lat temu
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 lat temu
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 lat temu
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 lat temu
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 5 lat temu
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 5 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 b56282756b [Docs] Clean up some code block languages (#14434) 4 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 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 lat temu
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 lat temu
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 lat temu
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 lat temu
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 lat temu
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 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
pr_checklist.md 4676a14596 More PR checklist updates (#14705) 4 lat temu
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 lat temu
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 lat temu
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 lat temu
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 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) 6 lat temu
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 lat temu
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 5 lat temu
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 lat temu
reference_info_json.md b7a346600c [Docs] Clean up reference_info_json.md (#14806) 4 lat temu
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 lat temu
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 lat temu
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 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 a03aa301de Remove Full Bootmagic (#13846) 5 lat temu
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) 5 lat temu
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 lat temu
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 lat temu
understanding_qmk.md b2a186cf92 Purge uGFX. (#14720) 4 lat temu
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 lat temu
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 lat temu
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 5 lat temu

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.