首頁 探索 說明
註冊 登入
HuiJun
/
qmk_firmware
1
0
複刻 0
檔案 問題管理 0 合併請求 0 Wiki
目錄樹: 1dbbd2b6b0
分支列表 標籤列表
qmk_firmware
/
docs
Ryan c05e8afe45 Joystick feature updates (#16732) 3 年之前
..
ChangeLog cf31355f08 Changelog 2022q1 (#16380) 3 年之前
gitbook 4580d3a730 RGB improvements (#1684) 7 年之前
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 3 年之前
ja e71f8f89d2 Merge remote-tracking branch 'origin/master' into develop 3 年之前
zh-cn 75544d9127 Move Doxygen docs to subdirectory (#16561) 3 年之前
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 年之前
CNAME 4d26137e2a Create CNAME 7 年之前
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 年之前
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 3 年之前
_summary.md 9ee2effe8e HD44780 driver rework (#16370) 3 年之前
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 年之前
api_development_environment.md 99850aabca Add API documentation 5 年之前
api_development_overview.md 99850aabca Add API documentation 5 年之前
api_docs.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 年之前
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 5 年之前
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
breaking_changes.md cf31355f08 Changelog 2022q1 (#16380) 3 年之前
breaking_changes_history.md cf31355f08 Changelog 2022q1 (#16380) 3 年之前
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 5 年之前
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 3 年之前
cli.md fcf150bd82 Streamline the macos install process 5 年之前
cli_commands.md efc9c525b1 CLI: Add 'via2json' subcommand (#16468) 3 年之前
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 5 年之前
cli_development.md da6d6ce2e1 Some docs improvements (#15845) 3 年之前
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) 3 年之前
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 3 年之前
compatible_microcontrollers.md 77062e9a36 Add L432, L442. (#16016) 3 年之前
config_options.md 02655690f4 [Core] Add compile/make macro to core (#15959) 3 年之前
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 3 年之前
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 3 年之前
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 3 年之前
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 3 年之前
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 3 年之前
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 5 年之前
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 3 年之前
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
custom_quantum_functions.md 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) 3 年之前
data_driven_config.md ace0603f4f Change data driven "str" type to represent a quoted string literal (#16516) 3 年之前
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 5 年之前
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 3 年之前
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 3 年之前
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 4 年之前
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
faq_debug.md 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 3 年之前
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 4 年之前
faq_keymap.md f529580860 Basic keycode overhaul (#14726) 3 年之前
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 3 年之前
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 4 年之前
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 3 年之前
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 3 年之前
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
feature_bluetooth.md 7d685956cc Rename `AdafruitBLE` to `BluefruitLE` (#16127) 3 年之前
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 3 年之前
feature_combo.md 21958a9343 New combo configuration options (#15083) 3 年之前
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 3 年之前
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 3 年之前
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 3 年之前
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 4 年之前
feature_encoders.md 8d5eacb7dd Add support for encoder mapping. (#13286) 3 年之前
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 3 年之前
feature_haptic_feedback.md 1d11ae3087 Rip out old macro and action_function system (#16025) 3 年之前
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) 3 年之前
feature_joystick.md c05e8afe45 Joystick feature updates (#16732) 3 年之前
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) 3 年之前
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 3 年之前
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 3 年之前
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
feature_leader_key.md b1f8622513 [Docs] Update feature_leader_key.md (#16344) 3 年之前
feature_led_indicators.md 3e5cb1da0f Improve description of LED state data sync option (#16302) 3 年之前
feature_led_matrix.md 0452ad9479 Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989) 3 年之前
feature_macros.md f52cc210b8 [Docs] feature_macro.md: minor formatting fix (#16205) 3 年之前
feature_midi.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 3 年之前
feature_mouse_keys.md 80dbdb2a61 Merge remote-tracking branch 'origin/master' into develop 3 年之前
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) 3 年之前
feature_pointing_device.md 86b123141b docs: fix code sample (#16623) 3 年之前
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 3 年之前
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 3 年之前
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
feature_rgb_matrix.md dc9eb21332 add the ability to change the pwm frequency for the IS31FL3737B (#16718) 3 年之前
feature_rgblight.md 259cf76966 Link WS2812 driver page from rgb feature docs (#16366) 3 年之前
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 年之前
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
feature_split_keyboard.md 43d18321e3 Merge remote-tracking branch 'origin/master' into develop 3 年之前
feature_st7565.md 37fba09021 ST7565 invert (#13237) 4 年之前
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop 3 年之前
feature_swap_hands.md 8d5eacb7dd Add support for encoder mapping. (#13286) 3 年之前
feature_tap_dance.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 年之前
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 5 年之前
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 年之前
feature_unicode.md f634fddd34 Remove `send_unicode_hex_string()` (#16518) 3 年之前
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 3 年之前
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 3 年之前
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 3 年之前
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 3 年之前
flashing.md 2bface8f89 Add flash target for UF2 bootloaders (#16525) 3 年之前
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 年之前
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 3 年之前
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 5 年之前
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 3 年之前
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
gpio_control.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 3 年之前
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 3 年之前
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 3 年之前
hardware_keyboard_guidelines.md 87199eb2f5 add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 3 年之前
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) 3 年之前
index.html 16767312db Align docs to new-keyboard behaviour (#16357) 3 年之前
isp_flashing_guide.md dde4120a1e ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 3 年之前
keycodes.md 02655690f4 [Core] Add compile/make macro to core (#15959) 3 年之前
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 3 年之前
keycodes_magic.md 2726856cde Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 3 年之前
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 年之前
keymap.md da6d6ce2e1 Some docs improvements (#15845) 3 年之前
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 年之前
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 年之前
newbs_building_firmware.md d3584be431 [Docs] Update newbs_building_firmware.md (#16333) 3 年之前
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 年之前
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) 3 年之前
newbs_getting_started.md 96b6ddf4bf fixed typo in docs/newbs_getting_started.md (#16501) 3 年之前
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 年之前
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 5 年之前
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) 3 年之前
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 5 年之前
newbs_learn_more_resources.md 8901c9eca1 Add Atom editor suggestion (#15969) 3 年之前
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 年之前
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 3 年之前
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 年之前
other_vscode.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 年之前
platformdev_chibios_earlyinit.md 5fb93934d0 Fixes for bootloader refactor build failures (#15638) 3 年之前
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 5 年之前
porting_your_keyboard_to_qmk.md 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378) 3 年之前
power.txt bb53635f33 Trim trailing whitespace 7 年之前
pr_checklist.md 61ba8efa3e Update pr_checklist.md (#16484) 3 年之前
proton_c_conversion.md 75544d9127 Move Doxygen docs to subdirectory (#16561) 3 年之前
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 年之前
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 年之前
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 年之前
quantum_keycodes.md 02655690f4 [Core] Add compile/make macro to core (#15959) 3 年之前
redirects.json d569f08771 Configuration system for CLI (#6708) 5 年之前
ref_functions.md 3502bbbd16 Fix typo in docs/ref_functions.md (#16690) 3 年之前
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 3 年之前
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 3 年之前
reference_info_json.md 8014fb14b6 Fix in-page links in reference_info_json.md (#16487) 3 年之前
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 3 年之前
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 3 年之前
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 4 年之前
squeezing_avr.md e01307f265 Typo in squeezing_avr.md (#16506) 3 年之前
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 5 年之前
sw.js 303f425c6b Fix up info boxes. 7 年之前
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 3 年之前
tap_hold.md 6c40b6856b [Docs] Include ASCII diagram to explain tap-hold modes (#15873) 3 年之前
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 5 年之前
uart_driver.md 04b51e381e Update UART driver API (#14839) 3 年之前
understanding_qmk.md da6d6ce2e1 Some docs improvements (#15845) 3 年之前
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 3 年之前
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 年之前
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) 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.