Halaman utama Jelajahi Bantuan
Masuk
logic855
/
qmk_firmware
cermin dari https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Berkas Masalah 0 Wiki
Pohon: 6e83b44940
Ranting Tag
qmk_firmware
/
docs
Albert Y fed36fc5f8 Adjust mouse key defaults (#15883) 4 tahun lalu
..
ChangeLog 7f7364c559 [Core] Split support for pointing devices. (#15304) 4 tahun lalu
gitbook 4580d3a730 RGB improvements (#1684) 9 tahun lalu
ja 282e916d86 Remove use of __flash due to LTO issues (#15268) 4 tahun lalu
zh-cn f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 tahun lalu
CNAME 4d26137e2a Create CNAME 8 tahun lalu
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 tahun lalu
_summary.md 88fe5c16a5 Changelog 2021q4 (#15325) 4 tahun lalu
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 tahun lalu
api_development_environment.md 99850aabca Add API documentation 6 tahun lalu
api_development_overview.md 99850aabca Add API documentation 6 tahun lalu
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 tahun lalu
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
breaking_changes.md 99ec5e39cf Fix last merge date (#15327) 4 tahun lalu
breaking_changes_history.md 88fe5c16a5 Changelog 2021q4 (#15325) 4 tahun lalu
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 tahun lalu
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 tahun lalu
cli.md fcf150bd82 Streamline the macos install process 6 tahun lalu
cli_commands.md aecb387692 Add test filter to 'qmk pytest' (#15432) 4 tahun lalu
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 tahun lalu
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) 4 tahun lalu
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 4 tahun lalu
compatible_microcontrollers.md dcb0c4e51e Add example implementations for compatible MCUs list (#15935) 4 tahun lalu
config_options.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 tahun lalu
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 tahun lalu
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 tahun lalu
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 tahun lalu
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 tahun lalu
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
custom_quantum_functions.md 36d123e9c5 Add support for deferred executors. (#14859) 4 tahun lalu
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 tahun lalu
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 tahun lalu
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 tahun lalu
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 tahun lalu
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
faq_debug.md 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 4 tahun lalu
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 tahun lalu
faq_keymap.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 tahun lalu
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 tahun lalu
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 tahun lalu
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 tahun lalu
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_bluetooth.md 8d604e707b [Docs] Updated typo on feature_bluetooth.md (#15466) 4 tahun lalu
feature_bootmagic.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 tahun lalu
feature_combo.md 21958a9343 New combo configuration options (#15083) 4 tahun lalu
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 tahun lalu
feature_debounce_type.md 25713dc222 Add sym_defer_pr debouncer type (#14948) 4 tahun lalu
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 tahun lalu
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 tahun lalu
feature_encoders.md 6f043c5497 Volume as default encoder documentation example (#15678) 4 tahun lalu
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 tahun lalu
feature_haptic_feedback.md e95156d4d8 Documentation Typo fix (#15538) 4 tahun lalu
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 tahun lalu
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_key_lock.md 7f67504993 Added cancel_key_lock function (#15321) 4 tahun lalu
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 tahun lalu
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 tahun lalu
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 tahun lalu
feature_led_matrix.md ad09160b03 docs: fix typo in led matrix docs (#15972) 4 tahun lalu
feature_macros.md 8fe320baa6 Fix keymap.json macro example (#15567) 4 tahun lalu
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_mouse_keys.md fed36fc5f8 Adjust mouse key defaults (#15883) 4 tahun lalu
feature_oled_driver.md 464d67c68f Merge remote-tracking branch 'origin/master' into develop 4 tahun lalu
feature_pointing_device.md 6ebb44f17e [Bug][Core] Fix optical sensor firmware upload (#15919) 4 tahun lalu
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 4 tahun lalu
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 4 tahun lalu
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
feature_rgb_matrix.md 8a4fae3b32 [Docs] Recommend the use of RGB matrix functions for code (#15744) 4 tahun lalu
feature_rgblight.md 2baca55cda docs: fix typo in rgblight docs (#15960) 4 tahun lalu
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 tahun lalu
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
feature_split_keyboard.md 43d18321e3 Merge remote-tracking branch 'origin/master' into develop 4 tahun lalu
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 tahun lalu
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop 4 tahun lalu
feature_swap_hands.md d8324e8a9c Document swap-hands tap-toggle feature (#15229) 4 tahun lalu
feature_tap_dance.md 0acc0924db [Docs] Update feature_tap_dance.md (#14931) 4 tahun lalu
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 tahun lalu
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 tahun lalu
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 tahun lalu
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 tahun lalu
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 tahun lalu
feature_wpm.md 0391801267 Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 4 tahun lalu
flashing.md 755731f0ba Fix RESET not working for keyboards with Kiibohd bootloader (#15430) 4 tahun lalu
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 tahun lalu
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 tahun lalu
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 tahun lalu
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 4 tahun lalu
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 tahun lalu
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 tahun lalu
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 tahun lalu
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) 4 tahun lalu
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) 4 tahun lalu
index.html 1c1e6fa47d Remove stale docs translations (#15737) 4 tahun lalu
internals_defines.md ae7284edb8 rename api docs to internals 8 tahun lalu
internals_gpio_control.md 6e40dfa022 Add open-drain GPIO support. (#15282) 4 tahun lalu
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 tahun lalu
internals_midi_device.md ae7284edb8 rename api docs to internals 8 tahun lalu
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 tahun lalu
internals_midi_util.md ae7284edb8 rename api docs to internals 8 tahun lalu
internals_send_functions.md ae7284edb8 rename api docs to internals 8 tahun lalu
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 tahun lalu
isp_flashing_guide.md cc5a38e787 Rework ISP flashing guide (#14938) 4 tahun lalu
keycodes.md b45a037c7e Rename some Quantum keycodes (#15968) 4 tahun lalu
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
keycodes_magic.md 2726856cde Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 4 tahun lalu
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 tahun lalu
keymap.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
mod_tap.md 57f63e43d8 [Docs] Correct logic of tap hold statement (#14992) 4 tahun lalu
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 tahun lalu
newbs_building_firmware.md 362a65510a [Docs] Move QMK newbs build environment guide to next section (#15386) 4 tahun lalu
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) 4 tahun lalu
newbs_getting_started.md 362a65510a [Docs] Move QMK newbs build environment guide to next section (#15386) 4 tahun lalu
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 tahun lalu
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 tahun lalu
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) 4 tahun lalu
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 tahun lalu
newbs_learn_more_resources.md 8901c9eca1 Add Atom editor suggestion (#15969) 4 tahun lalu
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 tahun lalu
other_eclipse.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 tahun lalu
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 tahun lalu
platformdev_chibios_earlyinit.md 5fb93934d0 Fixes for bootloader refactor build failures (#15638) 4 tahun lalu
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 tahun lalu
power.txt bb53635f33 Trim trailing whitespace 8 tahun lalu
pr_checklist.md 88fe5c16a5 Changelog 2021q4 (#15325) 4 tahun lalu
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 tahun lalu
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 tahun lalu
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 tahun lalu
quantum_keycodes.md b45a037c7e Rename some Quantum keycodes (#15968) 4 tahun lalu
redirects.json d569f08771 Configuration system for CLI (#6708) 6 tahun lalu
ref_functions.md 435fa2c391 fix typo (#15569) 4 tahun lalu
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 tahun lalu
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 tahun lalu
reference_info_json.md c72ed7c024 CLI: Parse USB device version BCD (#14580) 4 tahun lalu
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 tahun lalu
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 tahun lalu
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 tahun lalu
squeezing_avr.md 93e55605d9 [Docs] fix typo and remove trailing whitespace (#15842) 4 tahun lalu
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 tahun lalu
sw.js 303f425c6b Fix up info boxes. 8 tahun lalu
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 tahun lalu
tap_hold.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 tahun lalu
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 tahun lalu
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 tahun lalu
understanding_qmk.md c2e0b283c3 [Docs] Reorder functions in Understanding QMK (#15357) 4 tahun lalu
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 tahun lalu
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 tahun lalu
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) 4 tahun lalu

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.