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: da1c562ddf
Větve Značky
qmk_firmware
/
docs
QMK Bot 6f82647e8d Merge remote-tracking branch 'origin/master' into develop před 4 roky
..
ChangeLog d0af56da33 Breaking changes for 2022q2. (#17221) před 4 roky
gitbook 4580d3a730 RGB improvements (#1684) před 9 roky
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) před 4 roky
ja 8545473307 Removes terminal from QMK. (#17258) před 4 roky
zh-cn 8545473307 Removes terminal from QMK. (#17258) před 4 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 8545473307 Removes terminal from QMK. (#17258) před 4 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 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 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 b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
breaking_changes.md 89a5d5aea0 Fixup command sequencing for master/develop. (#17227) před 4 roky
breaking_changes_history.md de6360feca stub changelog před 4 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 1f2b1dedcc Quantum Painter (#10174) před 4 roky
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
cli_development.md da6d6ce2e1 Some docs improvements (#15845) před 4 roky
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) před 4 roky
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) před 4 roky
compatible_microcontrollers.md 1c7e8b9a9d Added support for Wb32fq95 (#16871) před 4 roky
config_options.md 02655690f4 [Core] Add compile/make macro to core (#15959) před 4 roky
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) před 5 roky
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) před 4 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 b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
custom_quantum_functions.md 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) před 4 roky
data_driven_config.md ace0603f4f Change data driven "str" type to represent a quoted string literal (#16516) před 4 roky
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) před 6 roky
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 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 af84772a5f initial 24lc32a (#16990) 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 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) před 4 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 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) před 4 roky
feature_advanced_keycodes.md 8153b55e07 Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md (#17211) před 4 roky
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) před 5 roky
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) před 4 roky
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) před 4 roky
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) před 4 roky
feature_caps_word.md 68b16bba68 [Core] Add Caps Word feature to core (#16588) před 4 roky
feature_combo.md 21958a9343 New combo configuration options (#15083) před 4 roky
feature_command.md a03aa301de Remove Full Bootmagic (#13846) před 5 roky
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) před 4 roky
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 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 cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) před 6 roky
feature_encoders.md d0af56da33 Breaking changes for 2022q2. (#17221) před 4 roky
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) před 4 roky
feature_haptic_feedback.md f090881aeb [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) před 4 roky
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) před 4 roky
feature_joystick.md c05e8afe45 Joystick feature updates (#16732) před 4 roky
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) před 4 roky
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) před 4 roky
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) před 4 roky
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
feature_leader_key.md b1f8622513 [Docs] Update feature_leader_key.md (#16344) před 4 roky
feature_led_indicators.md a5a4597311 Refine LED indicator documentation (#16304) před 4 roky
feature_led_matrix.md f296e1d1e2 [Docs] Align LED Matrix docs with RGB matrix docs (#17140) před 4 roky
feature_macros.md f52cc210b8 [Docs] feature_macro.md: minor formatting fix (#16205) před 4 roky
feature_midi.md 75544d9127 Move Doxygen docs to subdirectory (#16561) před 4 roky
feature_mouse_keys.md 80dbdb2a61 Merge remote-tracking branch 'origin/master' into develop před 4 roky
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) před 4 roky
feature_pointing_device.md 690dc4bdaf Add support for multiple sensors to pmw3360 (#15996) před 4 roky
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) před 5 roky
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) před 4 roky
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 roky
feature_rgb_matrix.md 9e2fe4eff6 Make SPI Mode configurable and change default mode to 3 (#17263) před 4 roky
feature_rgblight.md 5841c755ae rgblight: Add functions to stop blinking one or all but one layer (#16859) 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
feature_split_keyboard.md 2de70e6f2d Add uf2-split-* make targets. (#17257) před 4 roky
feature_st7565.md 37fba09021 ST7565 invert (#13237) před 5 roky
feature_stenography.md d5aab127d2 [Docs] Update Steno Keycode Table (#17155) před 4 roky
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) před 4 roky
feature_tap_dance.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 roky
feature_thermal_printer.md 4c675a83ba Format keycode tables před 8 roky
feature_unicode.md f634fddd34 Remove `send_unicode_hex_string()` (#16518) před 4 roky
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) před 4 roky
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) před 4 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 6e4e50d5aa Merge remote-tracking branch 'origin/master' into develop před 4 roky
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) před 5 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 4 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 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) před 5 roky
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) před 4 roky
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) před 4 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 68b16bba68 [Core] Add Caps Word feature to core (#16588) před 4 roky
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) před 4 roky
keycodes_magic.md 2726856cde Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 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 da6d6ce2e1 Some docs improvements (#15845) před 4 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 d3584be431 [Docs] Update newbs_building_firmware.md (#16333) před 4 roky
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) před 4 roky
newbs_getting_started.md 40e33d03a8 Recommend pillow as part of manual MSYS install (#17133) 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 8901c9eca1 Add Atom editor suggestion (#15969) 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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) před 5 roky
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 roky
other_vscode.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) před 4 roky
platformdev_chibios_earlyinit.md bbab8eb993 Make bootloader_jump for dualbank STM32 respect STM32_BOOTLOADER_DUAL_BANK_DELAY (#17178) před 4 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 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) před 4 roky
power.txt bb53635f33 Trim trailing whitespace před 8 roky
pr_checklist.md dba5b730a3 Update pr_checklist.md (#17122) před 4 roky
proton_c_conversion.md 75544d9127 Move Doxygen docs to subdirectory (#16561) před 4 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 787a68948f [Core] Add Reboot keycode to core (#15990) před 4 roky
quantum_painter.md 1f2b1dedcc Quantum Painter (#10174) před 4 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 3502bbbd16 Fix typo in docs/ref_functions.md (#16690) před 4 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 8014fb14b6 Fix in-page links in reference_info_json.md (#16487) před 4 roky
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) před 4 roky
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) před 5 roky
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop před 5 roky
squeezing_avr.md b1681fb6a1 [Core] Allow usage of AVRs minimal printf library (#16266) 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 8f585153c4 Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) před 4 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 8545473307 Removes terminal from QMK. (#17258) před 4 roky
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) před 4 roky
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores před 9 roky
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) před 4 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.