Domů Procházet Nápověda
Registrovat se Přihlásit se
HuiJun
/
qmk_firmware
1
0
Rozštěpit 0
Soubory Úkoly 0 Pull Requesty 0 Wiki
Strom: 1fffcbc298
Větve Značky
qmk_firmware
/
docs
Nick Brassel 1fffcbc298 Revert "[Core] Add Pixel Flow RGB matrix effect (#15829)" (#16209) před 3 roky
..
ChangeLog 88fe5c16a5 Changelog 2021q4 (#15325) před 3 roky
gitbook 4580d3a730 RGB improvements (#1684) před 7 roky
ja 282e916d86 Remove use of __flash due to LTO issues (#15268) před 3 roky
zh-cn d48bff8342 [Docs] zh-cn documentation translate: hand-wire (#15666) před 3 roky
.nojekyll 9e5676650e Use docsfy to replace gitbook před 7 roky
CNAME 4d26137e2a Create CNAME před 7 roky
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 4 roky
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) před 3 roky
_summary.md 88fe5c16a5 Changelog 2021q4 (#15325) před 3 roky
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 4 roky
api_development_environment.md 99850aabca Add API documentation před 5 roky
api_development_overview.md 99850aabca Add API documentation před 5 roky
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) před 5 roky
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
breaking_changes.md 99ec5e39cf Fix last merge date (#15327) před 3 roky
breaking_changes_history.md 88fe5c16a5 Changelog 2021q4 (#15325) před 3 roky
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) před 5 roky
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) před 3 roky
cli.md fcf150bd82 Streamline the macos install process před 5 roky
cli_commands.md aecb387692 Add test filter to 'qmk pytest' (#15432) před 3 roky
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 5 roky
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) před 3 roky
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) před 3 roky
compatible_microcontrollers.md 0df93ec2f9 [Docs] Fix Header formatting in compatible mcu doc (#15438) před 3 roky
config_options.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) před 3 roky
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) před 3 roky
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) před 3 roky
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) před 3 roky
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) před 3 roky
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 3 roky
configurator_troubleshooting.md d5f34c4810 Polish Configurator section před 5 roky
contributing.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 3 roky
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
custom_quantum_functions.md 3403f5813c Point out that deferred execution needs to be enabled in rules.mk (#16196) před 3 roky
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) před 4 roky
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) před 5 roky
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) před 3 roky
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 3 roky
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) před 4 roky
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
faq_debug.md 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) před 3 roky
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) před 4 roky
faq_keymap.md f529580860 Basic keycode overhaul (#14726) před 3 roky
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) před 3 roky
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) před 4 roky
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) před 3 roky
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) před 3 roky
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
feature_bluetooth.md 8d604e707b [Docs] Updated typo on feature_bluetooth.md (#15466) před 3 roky
feature_bootmagic.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) před 3 roky
feature_combo.md b384599663 Link Macro example for COMBO_ACTION documentation (#15164) před 3 roky
feature_command.md a03aa301de Remove Full Bootmagic (#13846) před 3 roky
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) před 3 roky
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) před 3 roky
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) před 4 roky
feature_encoders.md b2fcc923cb [Docs] Update Encoder docs about multiple encoders (#16036) před 3 roky
feature_grave_esc.md f529580860 Basic keycode overhaul (#14726) před 3 roky
feature_haptic_feedback.md f529580860 Basic keycode overhaul (#14726) před 3 roky
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) před 5 roky
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers před 5 roky
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) před 3 roky
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) před 3 roky
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 4 roky
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) před 3 roky
feature_led_matrix.md ad09160b03 docs: fix typo in led matrix docs (#15972) před 3 roky
feature_macros.md 8fe320baa6 Fix keymap.json macro example (#15567) před 3 roky
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) před 4 roky
feature_oled_driver.md 0f0e90971b [Docs] OLED documentation edits (#15977) před 3 roky
feature_pointing_device.md be06ef6af5 [Docs] Fix typo in ADNS 9800 sensor name (#15956) před 3 roky
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) před 3 roky
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) před 3 roky
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
feature_rgb_matrix.md 1fffcbc298 Revert "[Core] Add Pixel Flow RGB matrix effect (#15829)" (#16209) před 3 roky
feature_rgblight.md a2ef11bb00 [Docs] Add reference to data sync options for RGB (#16144) před 3 roky
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 4 roky
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
feature_split_keyboard.md c4b0a06c79 [Docs] Improve Handedness by EEPROM documentation (#15615) před 3 roky
feature_st7565.md 37fba09021 ST7565 invert (#13237) před 4 roky
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop před 3 roky
feature_swap_hands.md d8324e8a9c Document swap-hands tap-toggle feature (#15229) před 3 roky
feature_tap_dance.md 0acc0924db [Docs] Update feature_tap_dance.md (#14931) před 3 roky
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) před 5 roky
feature_thermal_printer.md 4c675a83ba Format keycode tables před 7 roky
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 4 roky
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) před 3 roky
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) před 3 roky
feature_wpm.md c9fd698711 Reimplements WPM feature to be smaller & precise (#13902) před 3 roky
flashing.md 755731f0ba Fix RESET not working for keyboards with Kiibohd bootloader (#15430) před 3 roky
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 4 roky
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) před 3 roky
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) před 5 roky
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) před 3 roky
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) před 3 roky
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) před 3 roky
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) před 3 roky
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) před 3 roky
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) před 3 roky
index.html 1c1e6fa47d Remove stale docs translations (#15737) před 3 roky
internals_defines.md ae7284edb8 rename api docs to internals před 7 roky
internals_gpio_control.md 2728603fe6 Move tmk_core/common/<plat> (#13918) před 3 roky
internals_input_callback_reg.md ae7284edb8 rename api docs to internals před 7 roky
internals_midi_device.md ae7284edb8 rename api docs to internals před 7 roky
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals před 7 roky
internals_midi_util.md ae7284edb8 rename api docs to internals před 7 roky
internals_send_functions.md ae7284edb8 rename api docs to internals před 7 roky
internals_sysex_tools.md ae7284edb8 rename api docs to internals před 7 roky
isp_flashing_guide.md 03b1d9ef1f Add a warning about USBtinyISP limitations to the ISP flashing guide (#15898) před 3 roky
keycodes.md 9e92d8a905 Make note of upper limit for `UC()` (#15870) před 3 roky
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) před 3 roky
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) před 3 roky
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) před 5 roky
keymap.md f529580860 Basic keycode overhaul (#14726) před 3 roky
mod_tap.md 57f63e43d8 [Docs] Correct logic of tap hold statement (#14992) před 3 roky
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 4 roky
newbs_building_firmware.md 362a65510a [Docs] Move QMK newbs build environment guide to next section (#15386) před 3 roky
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 4 roky
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) před 3 roky
newbs_getting_started.md 362a65510a [Docs] Move QMK newbs build environment guide to next section (#15386) před 3 roky
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) před 5 roky
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) před 5 roky
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) před 3 roky
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers před 5 roky
newbs_learn_more_resources.md 8901c9eca1 Add Atom editor suggestion (#15969) před 3 roky
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 4 roky
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) před 3 roky
other_eclipse.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) před 3 roky
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) před 3 roky
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 4 roky
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) před 5 roky
power.txt bb53635f33 Trim trailing whitespace před 7 roky
pr_checklist.md 7d6e15423b Add some clarity regarding new board definitions (#16018) před 3 roky
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) před 4 roky
qmk.css ccc87421e7 Some more tweaks to make everything look nice před 7 roky
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 4 roky
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 4 roky
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers před 5 roky
redirects.json d569f08771 Configuration system for CLI (#6708) před 5 roky
ref_functions.md 435fa2c391 fix typo (#15569) před 3 roky
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) před 3 roky
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) před 3 roky
reference_info_json.md b7a346600c [Docs] Clean up reference_info_json.md (#14806) před 3 roky
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) před 3 roky
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) před 3 roky
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop před 4 roky
squeezing_avr.md 1fffcbc298 Revert "[Core] Add Pixel Flow RGB matrix effect (#15829)" (#16209) před 3 roky
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 5 roky
sw.js 303f425c6b Fix up info boxes. před 7 roky
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) před 3 roky
tap_hold.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) před 3 roky
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) před 5 roky
uart_driver.md 04b51e381e Update UART driver API (#14839) před 3 roky
understanding_qmk.md c2e0b283c3 [Docs] Reorder functions in Understanding QMK (#15357) před 3 roky
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) před 3 roky
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores před 8 roky
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) před 3 roky

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.