ホーム エクスプローラ ヘルプ
サインイン
logic855
/
qmk_firmware
同期ミラー https://github.com/qmk/qmk_firmware.git
1
0
フォーク 1
ファイル 課題 0 Wiki
ツリー: 6bbe8b6edd
ブランチ タグ
qmk_firmware
/
docs
Ryan 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 3 年 前
..
ChangeLog 9b5b072255 2022q3 Changelog. (#18180) 4 年 前
gitbook 4580d3a730 RGB improvements (#1684) 9 年 前
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 年 前
ja 13dab7f050 Merge remote-tracking branch 'origin/master' into develop 3 年 前
zh-cn 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 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 00a4774243 Merge remote-tracking branch 'origin/master' into develop 3 年 前
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 年 前
api_development_environment.md 99850aabca Add API documentation 6 年 前
api_development_overview.md 99850aabca Add API documentation 6 年 前
api_docs.md 5e4b076af3 Remove legacy keycodes, part 5 (#18710) 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 c0763363db [Docs] Fix tables in Audio driver document (#17780) 4 年 前
breaking_changes.md 9b5b072255 2022q3 Changelog. (#18180) 4 年 前
breaking_changes_history.md 9b5b072255 2022q3 Changelog. (#18180) 4 年 前
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 年 前
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 年 前
cli.md fcf150bd82 Streamline the macos install process 6 年 前
cli_commands.md 959f4cbb62 docs: some typos (#18582) 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 959f4cbb62 docs: some typos (#18582) 3 年 前
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) 3 年 前
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) 4 年 前
config_options.md c255174cf3 Implement split comms watchdog (#18599) 3 年 前
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 年 前
configurator_default_keymaps.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 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 f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 年 前
custom_matrix.md 8224f62806 Make debounce() signal changes in the cooked matrix as return value (#17554) 4 年 前
custom_quantum_functions.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 年 前
data_driven_config.md e6a1afb8f1 [Docs] Fix typo in data driven config docs (#18095) 4 年 前
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 年 前
documentation_templates.md fc394dfdd4 [Docs] Fix link to keyboard layout editor (#18801) 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 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 年 前
feature_audio.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 3 年 前
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 年 前
feature_autocorrect.md fb29c0ae53 [Core] Add getreuer's Autocorrect feature to core (#15699) 3 年 前
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 4 年 前
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) 4 年 前
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 年 前
feature_caps_word.md 78c4907f34 [Docs] Clarify CAPS_WORD behaviors (#18137) 3 年 前
feature_combo.md 9632360caa Use a macro to compute the size of arrays at compile time (#18044) 3 年 前
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 年 前
feature_converters.md 1155140631 Add Elite-C to converters (#18309) 3 年 前
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 年 前
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 4 年 前
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 年 前
feature_dynamic_macros.md 9dc7b9d40c Added Wait time to sending each Keys for Dynamic Macros function (#16800) 4 年 前
feature_eeprom.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 年 前
feature_encoders.md a4d1d8b745 Resolve conflict merging master to develop (#18297) 3 年 前
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 年 前
feature_haptic_feedback.md f090881aeb [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 4 年 前
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 4 年 前
feature_joystick.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 3 年 前
feature_key_lock.md 7cbff9d921 Deprecate `KC_LOCK` for `QK_LOCK` (#18796) 3 年 前
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 年 前
feature_layers.md 2c516fab29 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 年 前
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 年 前
feature_leader_key.md b33fc34967 Deprecate `KC_LEAD` for `QK_LEAD` (#18792) 3 年 前
feature_led_indicators.md cbe1c22d46 quantum: led: split out led_update_ports() for customization of led behaviour (#14452) 3 年 前
feature_led_matrix.md 64b1ed4550 Fix Per Key LED Indicator Callbacks (#18450) 3 年 前
feature_macros.md 959f4cbb62 docs: some typos (#18582) 3 年 前
feature_midi.md 026d0e8bf1 Update feature_midi.md (#17390) 4 年 前
feature_mouse_keys.md c725b6bf89 [Core] Mouse key kinetic mode fix (#17176) 4 年 前
feature_oled_driver.md 959f4cbb62 docs: some typos (#18582) 3 年 前
feature_pointing_device.md 94d5fe6f90 Allow Active High for Pointing Device Motion Pin (#18404) 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) 3 年 前
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 年 前
feature_rgb_matrix.md 9d4c4ceee1 4 Driver support for IS31FL3737 (#18750) 3 年 前
feature_rgblight.md 18dc851e37 Remove legacy Debug keycode (#18769) 3 年 前
feature_secure.md 2a3dd95229 Add basic secure docs (#17577) 4 年 前
feature_send_string.md 3ecb0a80af Feature-ify Send String (#17275) 4 年 前
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 年 前
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年 前
feature_split_keyboard.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 年 前
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 年 前
feature_stenography.md 95c1cc425e Rename postprocess_steno_user → post_process_steno_user (#17823) 4 年 前
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) 4 年 前
feature_tap_dance.md 269600f640 Update feature_tap_dance.md (#18509) 3 年 前
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 年 前
feature_unicode.md 8833b28361 Remove `UNICODE_KEY_OSX` and `UC_OSX` (#18290) 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 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 年 前
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 年 前
flashing.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 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 36d123e9c5 Add support for deferred executors. (#14859) 4 年 前
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 4 年 前
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 年 前
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) 4 年 前
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 年 前
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 4 年 前
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 81be7bb7b5 Fix i2c driver doc: Incorrect name (#16898) 4 年 前
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 4 年 前
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 4 年 前
keycodes.md 6bbe8b6edd Normalise Joystick and Programmable Button keycodes (#18832) 3 年 前
keycodes_basic.md a26f1ddafa Chromeos keycodes (#18212) 3 年 前
keycodes_magic.md 871eeae4ea PoC: Swap Escape and Caps (#16336) 4 年 前
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 年 前
keymap.md 4b2d71de52 Remove legacy international keycodes (#18588) 3 年 前
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 年 前
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年 前
newbs_building_firmware.md 51f2d27321 Fix typo (#18526) 3 年 前
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 年 前
newbs_building_firmware_workflow.md 64acbcb42a [Docs] Building with GitHub Userspace (#16271) 4 年 前
newbs_flashing.md 4e35697e1a Add note about qmk doctor in newbs_flashing.md (#15688) 4 年 前
newbs_getting_started.md 8fa7b62011 Attempt to discourage manual MSYS install for new users (#17556) 4 年 前
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 b56282756b [Docs] Clean up some code block languages (#14434) 4 年 前
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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 年 前
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 年 前
other_vscode.md 5f72d54299 Update other_vscode.md (#17317) 4 年 前
platformdev_blackpill_f4x1.md dbce41cb6b [Docs] Update platformdev_blackpill_f411.md (#18666) 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 0d5e0e3b2a Merge remote-tracking branch 'origin/master' into develop 3 年 前
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 年 前
porting_your_keyboard_to_qmk.md 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) 4 年 前
power.txt bb53635f33 Trim trailing whitespace 8 年 前
pr_checklist.md dc7d2692c6 Grammar Fix for PR Checklist (#18540) 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 a6f3194397 Add ability to enter bootloader mode from `QK_MAKE` (#17745) 4 年 前
quantum_painter.md 1849897444 [QP] Add RGB565 surface. Docs clarification, cleanup, tabsification, and reordering. (#18396) 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) 6 年 前
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) 4 年 前
reference_info_json.md 00dc764f72 [docs] Improve documentation regarding info.json (#18508) 3 年 前
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 年 前
serial_driver.md d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) 4 年 前
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 年 前
squeezing_avr.md fb6e821541 Add Elite-Pi converter (#18236) 3 年 前
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 年 前
sw.js 303f425c6b Fix up info boxes. 8 年 前
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 年 前
tap_hold.md a3f9992cc9 docs: fix typos (#18671) 3 年 前
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 年 前
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 年 前
understanding_qmk.md 39e611794d [Docs] Update 'Process Record' according to the code (#18209) 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 d717396708 [Core] Add Raspberry Pi RP2040 support (#14877) 4 年 前

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.