Domů Procházet Nápověda
Přihlásit se
logic855
/
qmk_firmware
zrcadlo https://github.com/qmk/qmk_firmware.git
1
0
Rozštěpit 1
Soubory Úkoly 0 Wiki
Strom: 2f15cde2d1
Větve Značky
qmk_firmware
/
docs
QMK Bot e2ab98f960 Merge remote-tracking branch 'origin/master' into develop před 3 roky
..
ChangeLog 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) před 3 roky
gitbook 4580d3a730 RGB improvements (#1684) před 9 roky
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) před 4 roky
ja e2ab98f960 Merge remote-tracking branch 'origin/master' into develop před 3 roky
zh-cn 53423f0369 KC_GESC -> QK_GESC for cn and ja Docs (#19024) před 3 roky
.nojekyll 9e5676650e Use docsfy to replace gitbook před 8 roky
CNAME 4d26137e2a Create CNAME před 8 roky
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) před 4 roky
_summary.md 102f22f7e9 [Core] Quantum Painter - LVGL Integration (#18499) před 3 roky
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
api_development_environment.md 99850aabca Add API documentation před 6 roky
api_development_overview.md 99850aabca Add API documentation před 6 roky
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) před 3 roky
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) před 6 roky
audio_driver.md 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) před 3 roky
breaking_changes.md 9e78e65a56 2022 Nov 26 changelog. (#19164) před 3 roky
breaking_changes_history.md 08805cada0 Stub next develop dates před 3 roky
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) před 6 roky
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) před 4 roky
cli.md fcf150bd82 Streamline the macos install process před 6 roky
cli_commands.md 959f4cbb62 docs: some typos (#18582) před 3 roky
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
cli_development.md 959f4cbb62 docs: some typos (#18582) před 3 roky
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) před 4 roky
coding_conventions_c.md 959f4cbb62 docs: some typos (#18582) před 3 roky
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) před 3 roky
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) před 4 roky
config_options.md 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) před 3 roky
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) před 5 roky
configurator_default_keymaps.md 4d33f356a6 Macro keycode name refactoring (#18958) před 3 roky
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) před 5 roky
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) před 5 roky
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 4 roky
configurator_troubleshooting.md d5f34c4810 Polish Configurator section před 6 roky
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 4 roky
custom_matrix.md 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) před 4 roky
custom_quantum_functions.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) před 4 roky
data_driven_config.md 479d8de622 Format DD mappings and schemas (#18924) před 3 roky
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) před 6 roky
documentation_templates.md fc394dfdd4 [Docs] Fix link to keyboard layout editor (#18801) před 3 roky
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) před 4 roky
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 4 roky
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) před 4 roky
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) před 3 roky
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) před 5 roky
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) před 4 roky
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) před 4 roky
feature_advanced_keycodes.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) před 4 roky
feature_audio.md 69fa02c37d Align audio keycode names (#18962) před 3 roky
feature_auto_shift.md 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) před 3 roky
feature_autocorrect.md 2ff1d85290 Normalise Autocorrect keycodes (#18893) před 3 roky
feature_backlight.md 219afaba42 Reworked backlight keycodes. (#18961) před 3 roky
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) před 3 roky
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) před 4 roky
feature_caps_word.md a80b886751 Deprecate `CAPS_WORD`/`CAPSWRD` for `CW_TOGG` (#18834) před 3 roky
feature_combo.md efe520645e Normalise Combo keycodes (#18877) před 3 roky
feature_command.md a03aa301de Remove Full Bootmagic (#13846) před 5 roky
feature_converters.md a42ab90220 Add Bonsai C4 as a platform board file (#18901) před 3 roky
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) před 4 roky
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) před 3 roky
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) před 5 roky
feature_dynamic_macros.md fe18df9d41 Normalise Dynamic Macro keycodes (#18939) před 3 roky
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) před 3 roky
feature_encoders.md a4d1d8b745 Resolve conflict merging master to develop (#18297) před 4 roky
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) před 4 roky
feature_haptic_feedback.md e4d2ba9a4d Align haptic feedback keycode names (#18964) před 3 roky
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) před 4 roky
feature_joystick.md 1e95f7be8f Joystick feature improvements (#19052) před 3 roky
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop před 3 roky
feature_key_overrides.md 1d34f380eb Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` (#18843) před 3 roky
feature_layers.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) před 4 roky
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
feature_leader_key.md e2117564c5 Leader: remove `qk_` prefix (#19304) před 3 roky
feature_led_indicators.md 1124bbc1db Remove deprecated led_set_kb (#19273) před 3 roky
feature_led_matrix.md a5a20cc792 Change `LED_MATRIX_STARTUP_*` defines to `LED_MATRIX_DEFAULT_*` (#19080) před 3 roky
feature_macros.md 4d33f356a6 Macro keycode name refactoring (#18958) před 3 roky
feature_midi.md 8b658dcc9a Normalise MIDI keycodes (#18972) před 3 roky
feature_mouse_keys.md 2a61bfc27d add "inertia" mode for mouse keys (#18774) před 3 roky
feature_oled_driver.md a5c2eea6c1 Update OLED doc (#19213) před 3 roky
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) před 3 roky
feature_pointing_device.md d9cba6e978 Add `*_RIGHT` configuration for PMW33XX driver (#19243) před 3 roky
feature_programmable_button.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) před 3 roky
feature_ps2_mouse.md 0237ff0c62 [Core] Rework PS/2 driver selection (#17892) před 4 roky
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
feature_rgb_matrix.md e12ca14af8 Change `RGB_MATRIX_STARTUP_*` defines to `RGB_MATRIX_DEFAULT_*` (#19079) před 3 roky
feature_rgblight.md 18dc851e37 Remove legacy Debug keycode (#18769) před 3 roky
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) před 3 roky
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) před 4 roky
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 5 roky
feature_space_cadet.md 002b58f0e4 Normalise Space Cadet keycodes (#18864) před 3 roky
feature_split_keyboard.md c347e732be Remove legacy EEPROM clear keycodes (#18782) před 3 roky
feature_st7565.md 37fba09021 ST7565 invert (#13237) před 5 roky
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) před 4 roky
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) před 4 roky
feature_tap_dance.md 99174edf0a [Docs] Remove broken link (#19321) před 3 roky
feature_unicode.md 9e4cfcd181 UCIS: remove `qk_` prefix (#19302) před 3 roky
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) před 4 roky
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) před 3 roky
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) před 4 roky
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) před 4 roky
flashing.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) před 4 roky
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) před 4 roky
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 5 roky
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) před 5 roky
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) před 6 roky
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) před 4 roky
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) před 4 roky
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) před 4 roky
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) před 5 roky
hardware_keyboard_guidelines.md 1124bbc1db Remove deprecated led_set_kb (#19273) před 3 roky
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) před 4 roky
i2c_driver.md 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) před 4 roky
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) před 4 roky
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) před 4 roky
keycodes.md 690eb4a453 Fix RWIN typo within keycode list (#19155) před 3 roky
keycodes_basic.md a26f1ddafa Chromeos keycodes (#18212) před 4 roky
keycodes_magic.md 871eeae4ea PoC: Swap Escape and Caps (#16336) před 4 roky
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 roky
keymap.md 4b2d71de52 Remove legacy international keycodes (#18588) před 3 roky
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 roky
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) před 3 roky
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
newbs_building_firmware_workflow.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) před 4 roky
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) před 4 roky
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) před 4 roky
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) před 6 roky
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) před 6 roky
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers před 6 roky
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) před 4 roky
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
one_shot_keys.md 9ddb0165a4 fix typo (#19189) před 3 roky
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 roky
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) před 4 roky
platformdev_blackpill_f4x1.md dbce41cb6b [Docs] Update platformdev_blackpill_f411.md (#18666) před 3 roky
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) před 4 roky
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) před 4 roky
platformdev_rp2040.md 9dc3f79196 [RP2040] update i2c drivers to reflect peripheral number (#19277) před 3 roky
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) před 6 roky
porting_your_keyboard_to_qmk.md 6133b08e73 Rework input_pressed_state docs (#19267) před 3 roky
power.txt bb53635f33 Trim trailing whitespace před 8 roky
pr_checklist.md 9e78e65a56 2022 Nov 26 changelog. (#19164) před 3 roky
qmk.css ccc87421e7 Some more tweaks to make everything look nice před 8 roky
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
quantum_keycodes.md a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) před 4 roky
quantum_painter.md 9daf77b593 Add raw output option for QGF/QFF files. (#18998) před 3 roky
quantum_painter_lvgl.md 102f22f7e9 [Core] Quantum Painter - LVGL Integration (#18499) před 3 roky
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) před 4 roky
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) před 4 roky
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) před 4 roky
redirects.json d569f08771 Configuration system for CLI (#6708) před 7 roky
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) před 3 roky
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) před 4 roky
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) před 5 roky
reference_info_json.md 6133b08e73 Rework input_pressed_state docs (#19267) před 3 roky
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) před 4 roky
serial_driver.md 40aa9c8745 spelling fix (#18831) před 3 roky
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop před 5 roky
squeezing_avr.md fb6e821541 Add Elite-Pi converter (#18236) před 4 roky
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
sw.js 303f425c6b Fix up info boxes. před 8 roky
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) před 4 roky
tap_hold.md 515dd18c28 Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) před 3 roky
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) před 6 roky
uart_driver.md 04b51e381e Update UART driver API (#14839) před 4 roky
understanding_qmk.md 5233c69bc6 Remove thermal printer. (#18959) před 3 roky
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) před 5 roky
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores před 9 roky
ws2812_driver.md 27dec8d16d [Core] Allow custom timings for WS2812 PIO driver (#18006) před 3 roky

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.