صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
HuiJun
/
qmk_firmware
1
0
انشعاب 0
پرونده‌ها مشکلات 0 درخواست واکشی 0 ویکی
درخت: 596c4a1f87
شاخه‌ها تگ‌ها
qmk_firmware
/
docs
Zach White 596c4a1f87 Remove bin/qmk (#14231) 3 سال پیش
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) 3 سال پیش
de 596c4a1f87 Remove bin/qmk (#14231) 3 سال پیش
es ce379ef458 Merge remote-tracking branch 'origin/master' into develop 3 سال پیش
fr-fr 596c4a1f87 Remove bin/qmk (#14231) 3 سال پیش
gitbook 4580d3a730 RGB improvements (#1684) 7 سال پیش
he-il c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 3 سال پیش
ja b705020daf move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 3 سال پیش
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 3 سال پیش
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 3 سال پیش
ru-ru c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 3 سال پیش
zh-cn ce379ef458 Merge remote-tracking branch 'origin/master' into develop 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 10e8ed7430 [Docs] add README translation in portuguese (#7016) 5 سال پیش
_summary.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
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 c80e5f9f88 Audio system overhaul (#11820) 4 سال پیش
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 3 سال پیش
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 3 سال پیش
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 5 سال پیش
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) 4 سال پیش
cli.md fcf150bd82 Streamline the macos install process 5 سال پیش
cli_commands.md f155865804 remove qmk console, which is now part of the global cli (#14206) 3 سال پیش
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 5 سال پیش
cli_development.md fdcea06336 CLI/Docs: Fix the format commands' name (#13668) 3 سال پیش
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 4 سال پیش
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 5 سال پیش
compatible_microcontrollers.md b43c6bc176 Add support for STM32F407x MCUs. (#13718) 3 سال پیش
config_options.md 488aaa0980 Enable sync of OLED/ST7565 display on/off state on Splits (#13542) 3 سال پیش
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 3 سال پیش
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 4 سال پیش
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 e4823aadec Fix capitalisation of "GitHub" (#9184) 5 سال پیش
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 5 سال پیش
contributing.md 596c4a1f87 Remove bin/qmk (#14231) 3 سال پیش
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 5 سال پیش
custom_quantum_functions.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 4 سال پیش
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 a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 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 fc9fb2c775 Allow output of logging when running unit tests (#13556) 3 سال پیش
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 4 سال پیش
faq_keymap.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
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 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 سال پیش
feature_backlight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 سال پیش
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 4 سال پیش
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) 3 سال پیش
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 3 سال پیش
feature_digitizer.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 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 703f027717 Allow for removal of hysteresis on 4x encoders (#13698) 3 سال پیش
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 6 سال پیش
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) 4 سال پیش
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 5 سال پیش
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 4 سال پیش
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 5 سال پیش
feature_key_overrides.md 52cfc9259b [Feature] Key Overrides (#11422) 3 سال پیش
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 4 سال پیش
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 6 سال پیش
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 سال پیش
feature_led_indicators.md 8f6867ce95 [Docs] Added note about no split support (#12512) 3 سال پیش
feature_led_matrix.md 7da97c293d Rgb matrix/enable modes explicitly (#13758) 3 سال پیش
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 4 سال پیش
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) 4 سال پیش
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 4 سال پیش
feature_oled_driver.md 4e1c5887c5 [Core] Refactor OLED to allow easy addition of other types (#13454) 3 سال پیش
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 4 سال پیش
feature_ps2_mouse.md 07553b41f0 [Feature] Swap buttons on PS2 Mouse/Trackball (#9205) 3 سال پیش
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 4 سال پیش
feature_rgb_matrix.md 29ec2d8f42 [Docs] Add examples to RGB Matrix Indicators docs (#12797) 3 سال پیش
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) 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 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 3 سال پیش
feature_st7565.md 37fba09021 ST7565 invert (#13237) 4 سال پیش
feature_stenography.md 705774f7bf Steno combinedkeys (#12538) 3 سال پیش
feature_swap_hands.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 سال پیش
feature_tap_dance.md 03d258c222 matrix_scan_x -> x_task (#13748) 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 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 4 سال پیش
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 4 سال پیش
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 6 سال پیش
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) 3 سال پیش
flashing.md f314705921 adding uf2 flash support for blackpill 401 (#13968) 3 سال پیش
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 5 سال پیش
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 سال پیش
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 4 سال پیش
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 5 سال پیش
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) 4 سال پیش
getting_started_vagrant.md b705020daf move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 3 سال پیش
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 3 سال پیش
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 3 سال پیش
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 5 سال پیش
hardware_keyboard_guidelines.md 9fe7b5307a add 'include keyboard_features.mk' into build_keyboard.mk (#8422) 3 سال پیش
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 5 سال پیش
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) 4 سال پیش
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 4 سال پیش
internals_defines.md ae7284edb8 rename api docs to internals 7 سال پیش
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 سال پیش
internals_midi_device.md ae7284edb8 rename api docs to internals 7 سال پیش
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 سال پیش
internals_midi_util.md ae7284edb8 rename api docs to internals 7 سال پیش
internals_send_functions.md ae7284edb8 rename api docs to internals 7 سال پیش
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 سال پیش
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 4 سال پیش
keycodes.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 4 سال پیش
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 3 سال پیش
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 5 سال پیش
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 5 سال پیش
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) 4 سال پیش
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 5 سال پیش
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 سال پیش
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 4 سال پیش
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 4 سال پیش
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 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 5 سال پیش
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 5 سال پیش
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 4 سال پیش
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 cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 4 سال پیش
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 3 سال پیش
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 4 سال پیش
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 5 سال پیش
power.txt bb53635f33 Trim trailing whitespace 7 سال پیش
pr_checklist.md b459f314ec Explicitly state that VIA should not be enabled in the default keymap. (#13803) 3 سال پیش
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 4 سال پیش
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 54c58ea6de Add explicit id tags to externally linked headers 5 سال پیش
redirects.json d569f08771 Configuration system for CLI (#6708) 5 سال پیش
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 3 سال پیش
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 4 سال پیش
reference_info_json.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 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 سال پیش
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 5 سال پیش
sw.js 303f425c6b Fix up info boxes. 7 سال پیش
syllabus.md a03aa301de Remove Full Bootmagic (#13846) 3 سال پیش
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) 3 سال پیش
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 5 سال پیش
uart_driver.md 30b46fad57 UART driver refactor (#11637) 4 سال پیش
understanding_qmk.md 52cfc9259b [Feature] Key Overrides (#11422) 3 سال پیش
unit_testing.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 3 سال پیش
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 سال پیش
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 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.