홈 탐색 도움말
로그인
logic855
/
qmk_firmware
의 미러 https://github.com/qmk/qmk_firmware.git
1
0
포크 1
파일 이슈 0 위키
트리: daece508da
브랜치 태그
qmk_firmware
/
docs
shela f216c20fc7 Update Japanese document (#14766) 4 년 전
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) 5 년 전
de ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 년 전
es ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 년 전
fr-fr ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 년 전
gitbook 4580d3a730 RGB improvements (#1684) 9 년 전
he-il c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 년 전
ja f216c20fc7 Update Japanese document (#14766) 4 년 전
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 년 전
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 년 전
ru-ru c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 년 전
zh-cn 45f88af4a1 [Docs] update suspend_*_user examples (#14542) 4 년 전
.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 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 년 전
_summary.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 5 년 전
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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
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 c80e5f9f88 Audio system overhaul (#11820) 5 년 전
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 년 전
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 년 전
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 년 전
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) 5 년 전
cli.md fcf150bd82 Streamline the macos install process 6 년 전
cli_commands.md 3b28178deb `--parallel` improvements (#13800) 5 년 전
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 년 전
cli_development.md fdcea06336 CLI/Docs: Fix the format commands' name (#13668) 5 년 전
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 년 전
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 년 전
compatible_microcontrollers.md b43c6bc176 Add support for STM32F407x MCUs. (#13718) 5 년 전
config_options.md 02ab7b1888 [Core] Fix "6kro enable" and clarify naming (#14563) 4 년 전
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 년 전
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 년 전
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 e4823aadec Fix capitalisation of "GitHub" (#9184) 6 년 전
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 년 전
contributing.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 년 전
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 년 전
custom_quantum_functions.md 45f88af4a1 [Docs] update suspend_*_user examples (#14542) 4 년 전
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 년 전
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 년 전
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
driver_installation_zadig.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 년 전
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 5 년 전
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 년 전
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
faq_debug.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 년 전
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 년 전
faq_keymap.md bb356a1584 [Docs] Update path to keycode.h (#14263) 5 년 전
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 년 전
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 년 전
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 년 전
feature_backlight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 년 전
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 년 전
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) 5 년 전
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 5 년 전
feature_digitizer.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 5 년 전
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 년 전
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 년 전
feature_encoders.md 19e33b685f [Docs] Modify encoder_update_user example to return false (#14541) 4 년 전
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 년 전
feature_haptic_feedback.md 52cb19713b Fix documentation for NO_HAPTIC_MOD and NO_HAPTIC_FN features. (#14180) 4 년 전
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 년 전
feature_joystick.md 9e77cdf4e6 Bugfix for Joystick and JSON schema (#14295) 5 년 전
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 년 전
feature_key_overrides.md 1e7117317f Documentation: Fix links in key overrides (#14228) 5 년 전
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 년 전
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 년 전
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 년 전
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 년 전
feature_led_matrix.md ddb6821b97 [Docs] fix wrong directory for RGB Matrix animations (#14494) 4 년 전
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 년 전
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) 5 년 전
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 년 전
feature_oled_driver.md 657323a206 [Docs] fixed incorrect amount of steps for oled usage (#13519) 4 년 전
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 5 년 전
feature_ps2_mouse.md 07553b41f0 [Feature] Swap buttons on PS2 Mouse/Trackball (#9205) 5 년 전
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 년 전
feature_rgb_matrix.md ddb6821b97 [Docs] fix wrong directory for RGB Matrix animations (#14494) 4 년 전
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) 5 년 전
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 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 년 전
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 년 전
feature_stenography.md 705774f7bf Steno combinedkeys (#12538) 5 년 전
feature_swap_hands.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 년 전
feature_tap_dance.md 13f3e30e86 Fix link from feature_tap_dance.md to tapping term settings (#14741) 4 년 전
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 년 전
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 년 전
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 년 전
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 년 전
feature_velocikey.md 8a8fdd9a72 Highlight keycode (#14317) 5 년 전
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) 5 년 전
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 년 전
flashing_bootloadhid.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 년 전
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 년 전
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 5 년 전
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 년 전
getting_started_make_guide.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 년 전
getting_started_vagrant.md b705020daf move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 5 년 전
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 년 전
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 년 전
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 년 전
hardware_keyboard_guidelines.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 년 전
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) 5 년 전
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 년 전
internals_defines.md ae7284edb8 rename api docs to internals 8 년 전
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 년 전
internals_midi_device.md ae7284edb8 rename api docs to internals 8 년 전
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 년 전
internals_midi_util.md ae7284edb8 rename api docs to internals 8 년 전
internals_send_functions.md ae7284edb8 rename api docs to internals 8 년 전
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 년 전
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 년 전
keycodes.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 년 전
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 5 년 전
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 년 전
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 년 전
mod_tap.md 27d9579fd5 Document examples on intercepting Mod-Tap (#14502) 4 년 전
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 년 전
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 년 전
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 년 전
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 5 년 전
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 5 년 전
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 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 년 전
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 년 전
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 년 전
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 cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 년 전
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 년 전
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 년 전
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 년 전
power.txt bb53635f33 Trim trailing whitespace 8 년 전
pr_checklist.md 4676a14596 More PR checklist updates (#14705) 4 년 전
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 년 전
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 54c58ea6de Add explicit id tags to externally linked headers 6 년 전
redirects.json d569f08771 Configuration system for CLI (#6708) 7 년 전
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 5 년 전
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 년 전
reference_info_json.md 4791cfae1a Remove width, height and key_count from info.json (#14274) 5 년 전
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 년 전
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 년 전
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 년 전
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 년 전
sw.js 303f425c6b Fix up info boxes. 8 년 전
syllabus.md a03aa301de Remove Full Bootmagic (#13846) 5 년 전
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) 5 년 전
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 년 전
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 년 전
understanding_qmk.md 4f37084677 [Docs] Broken FAQ hyperlink (#14578) 4 년 전
unit_testing.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 년 전
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 년 전
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 5 년 전

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.