Startseite Erkunden Hilfe
Anmelden
logic855
/
qmk_firmware
Mirror von https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Dateien Issues 0 Wiki
Struktur: 3e1ac7a38f
Branches Tags
qmk_firmware
/
docs
Nick Brassel 8946aace5b Add instructions for debugging ARM with VSCode+BMP. (#11217) vor 2 Jahren
..
ChangeLog dc046bc215 2024q1 `develop` changelog. (#23150) vor 2 Jahren
gitbook 4580d3a730 RGB improvements (#1684) vor 9 Jahren
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) vor 4 Jahren
ja e2dbe39b94 Removal of bootmagic lite terminology (#22979) vor 2 Jahren
zh-cn 339bff6339 Move velocikey to within rgblight (#22123) vor 2 Jahren
.nojekyll 9e5676650e Use docsfy to replace gitbook vor 8 Jahren
CNAME 4d26137e2a Create CNAME vor 8 Jahren
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) vor 4 Jahren
_summary.md dc046bc215 2024q1 `develop` changelog. (#23150) vor 2 Jahren
adc_driver.md e884e42ce9 Generalise ADC driver source inclusion (#22448) vor 2 Jahren
apa102_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) vor 2 Jahren
api_development_environment.md 99850aabca Add API documentation vor 6 Jahren
api_development_overview.md 99850aabca Add API documentation vor 6 Jahren
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) vor 3 Jahren
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
audio_driver.md 29f8fa35cf [Audio] Enable Complementary output for PWM Hardware driver (#22726) vor 2 Jahren
breaking_changes.md dc046bc215 2024q1 `develop` changelog. (#23150) vor 2 Jahren
breaking_changes_history.md dc046bc215 2024q1 `develop` changelog. (#23150) vor 2 Jahren
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) vor 3 Jahren
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) vor 3 Jahren
cli.md cf3c8a2138 Give definition of 'CLI' for new users (#22647) vor 2 Jahren
cli_commands.md d95182f5b5 [documentation] QMK migrate docs patch (#22646) vor 2 Jahren
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
cli_development.md a638f6e5aa Fix minimum python version references (#22191) vor 2 Jahren
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) vor 4 Jahren
coding_conventions_c.md 2f1cac6e9f [Docs] Code markdown amendment (#21323) vor 3 Jahren
coding_conventions_python.md a638f6e5aa Fix minimum python version references (#22191) vor 2 Jahren
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) vor 3 Jahren
config_options.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) vor 2 Jahren
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_default_keymaps.md 961f0b7b2d Reallocate SAFE_RANGE (#19909) vor 3 Jahren
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) vor 4 Jahren
configurator_troubleshooting.md d5f34c4810 Polish Configurator section vor 6 Jahren
contributing.md 8895b13583 Documentation regarding user code removal/acceptance (#22507) vor 2 Jahren
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) vor 3 Jahren
custom_quantum_functions.md b8646bc40b Update naming convention for GPIO control macros (#23085) vor 2 Jahren
data_driven_config.md ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) vor 3 Jahren
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) vor 6 Jahren
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) vor 3 Jahren
driver_installation_zadig.md 29891b63f9 Update Atmel DFU driver assignments for dfu-programmer 1.x (#23165) vor 2 Jahren
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) vor 4 Jahren
eeprom_driver.md bf6f13a2b0 Consolidate some EEPROM Driver configuration (#22321) vor 2 Jahren
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) vor 3 Jahren
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) vor 5 Jahren
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) vor 4 Jahren
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) vor 3 Jahren
feature_advanced_keycodes.md e1afcda1c0 Update code example to match description (#20528) vor 3 Jahren
feature_audio.md 69fa02c37d Align audio keycode names (#18962) vor 3 Jahren
feature_auto_shift.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) vor 2 Jahren
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) vor 3 Jahren
feature_backlight.md 7ae826476e Move BACKLIGHT_PWM_PERIOD to correct docs section (#22480) vor 2 Jahren
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) vor 3 Jahren
feature_bootmagic.md e2dbe39b94 Removal of bootmagic lite terminology (#22979) vor 2 Jahren
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) vor 3 Jahren
feature_combo.md 7df44ffb75 Fix double code indenting (#23117) vor 2 Jahren
feature_command.md a03aa301de Remove Full Bootmagic (#13846) vor 5 Jahren
feature_converters.md 2450fe28ee Add Imera converter (#22419) vor 2 Jahren
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) vor 3 Jahren
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) vor 3 Jahren
feature_dip_switch.md 4682226e20 Keymap introspection for Dip Switches (#22543) vor 2 Jahren
feature_dynamic_macros.md 68efea70b2 Add direction to dynamic_macro_record_start_user (#19689) vor 3 Jahren
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) vor 3 Jahren
feature_encoders.md 567f808ea5 [Doc] Use number indexes for encoder code example (#22980) vor 2 Jahren
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) vor 4 Jahren
feature_haptic_feedback.md 0b802defd4 haptic: further naming cleanups (#21682) vor 3 Jahren
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) vor 3 Jahren
feature_joystick.md 77e8867498 Fix joystick initialization (#22953) vor 2 Jahren
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop vor 3 Jahren
feature_key_overrides.md 50844a8e67 Fix typos: key-modifer→key-modifier and interacton→interaction (#22464) vor 2 Jahren
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) vor 3 Jahren
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_leader_key.md bbf7a20b33 Refactor Leader key feature (#19632) vor 3 Jahren
feature_led_indicators.md b8646bc40b Update naming convention for GPIO control macros (#23085) vor 2 Jahren
feature_led_matrix.md 3ba88f7798 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) vor 2 Jahren
feature_macros.md ce81801480 Add latam spanish headers (#22542) vor 2 Jahren
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop vor 3 Jahren
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) vor 3 Jahren
feature_oled_driver.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) vor 2 Jahren
feature_os_detection.md 80f3da36e5 [Core] Add OS detection callbacks (#21777) vor 2 Jahren
feature_pointing_device.md 6b52c6d83d Cirque reachable calibration aide (#22803) vor 2 Jahren
feature_programmable_button.md 17ae28f0e4 Fix doc for programmable buttons. (#22136) vor 2 Jahren
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) vor 2 Jahren
feature_rawhid.md 31fdf7d899 add pywinusb lib to list of example libs for HID (#22747) vor 2 Jahren
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) vor 3 Jahren
feature_rgb_matrix.md 3ba88f7798 LED drivers: update PWM register defines for `g_<driver>_leds` (#23052) vor 2 Jahren
feature_rgblight.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) vor 2 Jahren
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) vor 3 Jahren
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) vor 3 Jahren
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) vor 3 Jahren
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) vor 3 Jahren
feature_split_keyboard.md ccec4867c8 Align `SPLIT_HAND_MATRIX_GRID` left/right logic with `SPLIT_HAND_PIN` (#22775) vor 2 Jahren
feature_st7565.md 37fba09021 ST7565 invert (#13237) vor 5 Jahren
feature_stenography.md 786ebf8760 Remove requirement for `keymap_steno.h` include in keymaps (#22423) vor 2 Jahren
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) vor 3 Jahren
feature_tap_dance.md b824faca71 Align location of tap dance keycode (#22742) vor 2 Jahren
feature_tri_layer.md 6e6fff866e Fix typo in `docs/feature_tri_layer.md` (#22232) vor 2 Jahren
feature_unicode.md 509a2b40b7 Fix old usage of UNICODE_MODE_MAC (#22238) vor 2 Jahren
feature_userspace.md 8895b13583 Documentation regarding user code removal/acceptance (#22507) vor 2 Jahren
feature_wpm.md 990ee8075e Fix typo in `feature_wpm.md` title (#20464) vor 3 Jahren
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) vor 4 Jahren
flashing.md a0ea7a6b17 feat, docs: WB32 flashing (#21217) vor 3 Jahren
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) vor 3 Jahren
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) vor 6 Jahren
getting_started_make_guide.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) vor 3 Jahren
gpio_control.md b8646bc40b Update naming convention for GPIO control macros (#23085) vor 2 Jahren
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) vor 4 Jahren
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
hardware_keyboard_guidelines.md e648155113 Rename `RGBLED_NUM` -> `RGBLIGHT_LED_COUNT` (#22570) vor 2 Jahren
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) vor 4 Jahren
i2c_driver.md b8646bc40b Update naming convention for GPIO control macros (#23085) vor 2 Jahren
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) vor 4 Jahren
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) vor 3 Jahren
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) vor 3 Jahren
keycodes_basic.md 0152dd811d Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) vor 3 Jahren
keycodes_magic.md 403b0addea Align magic keycodes (#19877) vor 3 Jahren
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) vor 4 Jahren
keymap.md a474cac2c3 Update keymap.md (#22834) vor 2 Jahren
mod_tap.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) vor 3 Jahren
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) vor 3 Jahren
newbs_building_firmware_configurator.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) vor 3 Jahren
newbs_building_firmware_workflow.md 0fb3aaec8e [Doc]: Correct Markdown syntax errors. (#22511) vor 2 Jahren
newbs_external_userspace.md 5501e804ff QMK Userspace (#22222) vor 2 Jahren
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) vor 3 Jahren
newbs_getting_started.md 8813bdf5dd Remove rosetta instructions for Apple Silicon (#22174) vor 2 Jahren
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_git_resynchronize_a_branch.md f667821ed3 [Docs] Resynchronizing Your Branch including submodules (#19268) vor 3 Jahren
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) vor 4 Jahren
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
one_shot_keys.md 9ddb0165a4 fix typo (#19189) vor 3 Jahren
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) vor 4 Jahren
other_vscode.md 8946aace5b Add instructions for debugging ARM with VSCode+BMP. (#11217) vor 2 Jahren
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) vor 3 Jahren
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) vor 3 Jahren
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) vor 4 Jahren
platformdev_rp2040.md 61fa6949fb [Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839) vor 2 Jahren
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) vor 6 Jahren
porting_your_keyboard_to_qmk.md f067f42305 [Docs] Discuss layout macro (#19803) vor 3 Jahren
power.txt bb53635f33 Trim trailing whitespace vor 8 Jahren
pr_checklist.md 5031e0e35c [docs] - reword PR checklist for vendor keymaps/userspace changes (#22725) vor 2 Jahren
qmk.css ccc87421e7 Some more tweaks to make everything look nice vor 8 Jahren
qmk_custom_dark.css e3c6467ab9 [Docs] Improve contrast for warnings in dark mode (#21928) vor 2 Jahren
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
quantum_keycodes.md 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) vor 3 Jahren
quantum_painter.md 5383335717 [Driver] ILI9486 on Quantum Painter (#18521) vor 2 Jahren
quantum_painter_lvgl.md 169b0f33f6 Lvgl rate control (#22049) vor 2 Jahren
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) vor 4 Jahren
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) vor 4 Jahren
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) vor 4 Jahren
redirects.json d569f08771 Configuration system for CLI (#6708) vor 7 Jahren
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) vor 3 Jahren
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) vor 4 Jahren
reference_glossary.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) vor 3 Jahren
reference_info_json.md f6709e65eb Add RGB matrix & LED Matrix support for IS31FL3729 (#21944) vor 2 Jahren
reference_keymap_extras.md e67d2c2f6f Add Canadian French input locale (#21456) vor 2 Jahren
serial_driver.md e0c00c35ce Clarify PIO define is optional in docs. (#22339) vor 2 Jahren
spi_driver.md c157c19b81 Dedupe I2C, SPI, UART driver inclusions (#22253) vor 2 Jahren
squeezing_avr.md 2450fe28ee Add Imera converter (#22419) vor 2 Jahren
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
support_deprecation_policy.md d1a430b348 Initial deprecation policy documentation. (#19908) vor 3 Jahren
sw.js 303f425c6b Fix up info boxes. vor 8 Jahren
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) vor 4 Jahren
tap_hold.md 87eaab600c Fixed non-executable codes in the documentation (#22600) vor 2 Jahren
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) vor 6 Jahren
uart_driver.md 61fa6949fb [Core] Allow ChibiOS `SIO` driver for `UART` driver (#22839) vor 2 Jahren
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) vor 3 Jahren
unit_testing.md dd94877ec6 Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889) vor 2 Jahren
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores vor 9 Jahren
ws2812_driver.md a931e6d7bd Update WS2812 docs and add APA102 docs (#22106) vor 2 Jahren

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.