Почетна Преглед Помоћ
Пријавите се
logic855
/
qmk_firmware
огледало од https://github.com/qmk/qmk_firmware.git
1
0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Дрво: 2efbdedebf
Гране Ознаке
qmk_firmware
/
docs
QMK Bot ff2f56ace8 Merge remote-tracking branch 'origin/develop' into xap пре 3 година
..
ChangeLog 32d865572c `develop` 2023q2 changelog (#21049) пре 3 година
gitbook 4580d3a730 RGB improvements (#1684) пре 9 година
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) пре 4 година
ja ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) пре 3 година
zh-cn 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) пре 3 година
.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 789edaaa14 Merge remote-tracking branch 'origin/develop' into xap пре 3 година
adc_driver.md 272281f1a0 Add analog support for RP2040 (#19453) пре 3 година
api_development_environment.md 99850aabca Add API documentation пре 6 година
api_development_overview.md 99850aabca Add API documentation пре 6 година
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) пре 3 година
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 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) пре 3 година
breaking_changes.md f2808dcbef Branch point for 2023q3 Breaking Change. пре 3 година
breaking_changes_history.md 32d865572c `develop` 2023q2 changelog (#21049) пре 3 година
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) пре 3 година
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) пре 3 година
cli.md fcf150bd82 Streamline the macos install process пре 6 година
cli_commands.md 102c42b14b `qmk find`: usability improvements (#20440) пре 3 година
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
cli_development.md 959f4cbb62 docs: some typos (#18582) пре 3 година
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) пре 4 година
coding_conventions_c.md 2f1cac6e9f [Docs] Code markdown amendment (#21323) пре 3 година
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) пре 3 година
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) пре 3 година
config_options.md 5faa23d54c Keymap introspection for combos. (#19670) пре 3 година
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_default_keymaps.md 961f0b7b2d Reallocate SAFE_RANGE (#19909) пре 3 година
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 22be5190ab Minor cleanup to breaking/checklist docs. (#19596) пре 3 година
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) пре 3 година
custom_quantum_functions.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) пре 3 година
data_driven_config.md ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) пре 3 година
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) пре 6 година
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) пре 3 година
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) пре 4 година
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) пре 4 година
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) пре 3 година
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) пре 5 година
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) пре 4 година
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
feature_advanced_keycodes.md e1afcda1c0 Update code example to match description (#20528) пре 3 година
feature_audio.md 69fa02c37d Align audio keycode names (#18962) пре 3 година
feature_auto_shift.md e9ff66d8ad Adds a way to separate tab from AUTO_SHIFT_SPECIAL. (#20996) пре 3 година
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) пре 3 година
feature_backlight.md 4137685f8e backlight: split AVR PWM and timer drivers (#21540) пре 3 година
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) пре 3 година
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) пре 4 година
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) пре 3 година
feature_combo.md 5faa23d54c Keymap introspection for combos. (#19670) пре 3 година
feature_command.md a03aa301de Remove Full Bootmagic (#13846) пре 5 година
feature_converters.md dbfbf6c2c4 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) пре 3 година
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) пре 3 година
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) пре 5 година
feature_dynamic_macros.md 68efea70b2 Add direction to dynamic_macro_record_start_user (#19689) пре 3 година
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) пре 3 година
feature_encoders.md c9f619124d Encodermap direction define. (#20454) пре 3 година
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) пре 4 година
feature_haptic_feedback.md b090354143 haptic: naming cleanups (#21551) пре 3 година
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
feature_joystick.md 917d93e968 [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) пре 3 година
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_key_overrides.md 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) пре 3 година
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) пре 3 година
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) пре 4 година
feature_leader_key.md bbf7a20b33 Refactor Leader key feature (#19632) пре 3 година
feature_led_indicators.md 1124bbc1db Remove deprecated led_set_kb (#19273) пре 3 година
feature_led_matrix.md 657bddb5c3 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) пре 3 година
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) пре 3 година
feature_oled_driver.md 2ddad246ce OLED Driver improvements (#20331) пре 3 година
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) пре 3 година
feature_pointing_device.md 59eb8940b0 Make Pointing Device Auto Layer more configurable (#20061) пре 3 година
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) пре 3 година
feature_ps2_mouse.md 0237ff0c62 [Core] Rework PS/2 driver selection (#17892) пре 4 година
feature_rawhid.md 8b7ac7f2ca Raw HID: documentation improvements (#21596) пре 3 година
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) пре 3 година
feature_rgb_matrix.md 657bddb5c3 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_rgblight.md f3a7cd5573 Merge remote-tracking branch 'origin/master' into develop пре 3 година
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) пре 3 година
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) пре 3 година
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) пре 3 година
feature_split_keyboard.md a518e1e5d8 Sync activity timestamps between sides. (#20192) пре 3 година
feature_st7565.md 37fba09021 ST7565 invert (#13237) пре 5 година
feature_stenography.md fcf8b804ed [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847) пре 3 година
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) пре 3 година
feature_tap_dance.md 2c70d38910 On-each-release tap dance function (#20255) пре 3 година
feature_tri_layer.md fe02abc479 [Core] Tri Layer Keys (#19795) пре 3 година
feature_unicode.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) пре 3 година
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) пре 4 година
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) пре 3 година
feature_wpm.md 990ee8075e Fix typo in `feature_wpm.md` title (#20464) пре 3 година
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) пре 4 година
flashing.md a0ea7a6b17 feat, docs: WB32 flashing (#21217) пре 3 година
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
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) пре 4 година
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 a4ed6ad0f5 Unicodemap keycodes rename (#21092) пре 3 година
gpio_control.md cf935d97ae Fix functions with empty params (#19647) пре 3 година
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) пре 4 година
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
hardware_keyboard_guidelines.md 4704a4e053 Merge remote-tracking branch 'origin/master' into develop пре 3 година
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) пре 4 година
i2c_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
index.html 90fc901624 mermaid? пре 4 година
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) пре 3 година
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) пре 3 година
keycodes_basic.md 0152dd811d Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) пре 3 година
keycodes_magic.md 403b0addea Align magic keycodes (#19877) пре 3 година
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) пре 4 година
keymap.md 95671148a4 [Docs] Change defines to enums in examples (#19793) пре 3 година
mod_tap.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) пре 3 година
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) пре 3 година
newbs_building_firmware_configurator.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) пре 3 година
newbs_building_firmware_workflow.md 43ce7b0df5 [Docs] Highlight keymap name entry (#21138) пре 3 година
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) пре 3 година
newbs_getting_started.md 4c6c387724 Add an emphasis on QMK MSYS terminal (#21168) пре 3 година
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 f667821ed3 [Docs] Resynchronizing Your Branch including submodules (#19268) пре 3 година
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) пре 4 година
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
one_shot_keys.md 9ddb0165a4 fix typo (#19189) пре 3 година
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) пре 4 година
other_vscode.md 1ca34c2168 Fix VS code live share extension link (#21585) пре 3 година
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) пре 3 година
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) пре 3 година
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) пре 4 година
platformdev_rp2040.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) пре 3 година
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) пре 6 година
porting_your_keyboard_to_qmk.md f067f42305 [Docs] Discuss layout macro (#19803) пре 3 година
power.txt bb53635f33 Trim trailing whitespace пре 8 година
pr_checklist.md 3142f2dfdf clarify what the heck pristine means for reasons (#20950) пре 3 година
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 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) пре 3 година
quantum_painter.md 26227d1f66 [Docs] Fix listed defaults in quantum painter docs (#21429) пре 3 година
quantum_painter_lvgl.md cf935d97ae Fix functions with empty params (#19647) пре 3 година
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) пре 4 година
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) пре 4 година
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) пре 4 година
redirects.json d569f08771 Configuration system for CLI (#6708) пре 7 година
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) пре 3 година
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 3fc9c03559 Remove `all` from list of animations in `info.json` (#19978) пре 3 година
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) пре 4 година
serial_driver.md 3f45fd4924 Fix serial_driver.md list item numbering (#19819) пре 3 година
spi_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
squeezing_avr.md 06a36824ad [Docs] Squeeze AVR with simplified magic config functions (#21477) пре 3 година
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
support_deprecation_policy.md d1a430b348 Initial deprecation policy documentation. (#19908) пре 3 година
sw.js 303f425c6b Fix up info boxes. пре 8 година
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) пре 4 година
tap_hold.md 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) пре 3 година
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) пре 6 година
uart_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) пре 3 година
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) пре 3 година
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) пре 4 година
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores пре 9 година
ws2812_driver.md 47966dc2a6 Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) пре 3 година
xap.md 90fc901624 mermaid? пре 4 година
xap_0.0.1.md 9fcab705a9 Align client/docs gen with recent changes пре 3 година
xap_0.1.0.md 9fcab705a9 Align client/docs gen with recent changes пре 3 година
xap_0.2.0.md 9fcab705a9 Align client/docs gen with recent changes пре 3 година
xap_0.3.0.md 9fcab705a9 Align client/docs gen with recent changes пре 3 година
xap_protocol.md 9fcab705a9 Align client/docs gen with recent changes пре 3 година

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.