Domů Procházet Nápověda
Přihlásit se
logic855
/
qmk_firmware
zrcadlo https://github.com/qmk/qmk_firmware.git
1
0
Rozštěpit 1
Soubory Úkoly 0 Wiki
Strom: 36d8d7df5a
Větve Značky
qmk_firmware
/
docs
s-show 344b1b4395 Add ID to "## Advanced Macros". (#12830) před 5 roky
..
ChangeLog 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
fr-fr 59c572eaf0 Cleanup junk characters, part 1 (#13282) před 5 roky
gitbook 4580d3a730 RGB improvements (#1684) před 9 roky
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
ja 344b1b4395 Add ID to "## Advanced Macros". (#12830) před 5 roky
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
.nojekyll 9e5676650e Use docsfy to replace gitbook před 8 roky
CNAME 4d26137e2a Create CNAME před 8 roky
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) před 6 roky
_summary.md b10728edc1 [Docs] added basic midi documention of common features (#13113) před 5 roky
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
api_development_environment.md 99850aabca Add API documentation před 6 roky
api_development_overview.md 99850aabca Add API documentation před 6 roky
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) před 6 roky
audio_driver.md c80e5f9f88 Audio system overhaul (#11820) před 5 roky
breaking_changes.md e7ddbc394b Update merge sequence to reflect no-ff, no-squash. (#13038) před 5 roky
breaking_changes_history.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) před 6 roky
cli.md fcf150bd82 Streamline the macos install process před 6 roky
cli_commands.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) před 5 roky
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) před 6 roky
compatible_microcontrollers.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
config_options.md f173963d95 [Docs] Fix typos in audio config in main config page (#12928) před 5 roky
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) před 5 roky
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
configurator_troubleshooting.md d5f34c4810 Polish Configurator section před 6 roky
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) před 6 roky
custom_quantum_functions.md c66df16644 2020 November 28 Breaking Changes Update (#11053) před 5 roky
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) před 5 roky
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) před 6 roky
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) před 5 roky
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) před 5 roky
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
faq_debug.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) před 5 roky
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) před 5 roky
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) před 5 roky
feature_audio.md 2538d341d8 Document user song list file (#13101) před 5 roky
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_backlight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) před 6 roky
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) před 6 roky
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) před 5 roky
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) před 7 roky
feature_debounce_type.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 5 roky
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) před 6 roky
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) před 6 roky
feature_encoders.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) před 7 roky
feature_haptic_feedback.md 6a5f29208e [Docs] Update feature_haptic_feedback.md (#11859) před 5 roky
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) před 6 roky
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) před 5 roky
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers před 6 roky
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) před 5 roky
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) před 7 roky
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) před 5 roky
feature_led_matrix.md 875bb48a20 Top level heading for common config (LED Matrix) (#13153) před 5 roky
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) před 5 roky
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) před 5 roky
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) před 5 roky
feature_oled_driver.md 2f08a34394 OLED driver tweaks (#13215) před 5 roky
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop před 5 roky
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) před 5 roky
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) před 5 roky
feature_rgb_matrix.md 968e4f96a4 Top level heading for common config (RGB Matrix) (#13120) před 5 roky
feature_rgblight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 5 roky
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
feature_split_keyboard.md 449b4b8d86 [Docs] Update feature_split_keyboard.md (#13205) před 5 roky
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
feature_swap_hands.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_tap_dance.md 653ecf91c2 More Tap Dance docs improvements (#12358) před 5 roky
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) před 6 roky
feature_thermal_printer.md 4c675a83ba Format keycode tables před 8 roky
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) před 5 roky
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) před 7 roky
feature_wpm.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
flashing.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) před 6 roky
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 5 roky
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) před 5 roky
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) před 6 roky
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) před 5 roky
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) před 6 roky
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) před 6 roky
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) před 5 roky
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) před 5 roky
internals_defines.md ae7284edb8 rename api docs to internals před 8 roky
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
internals_input_callback_reg.md ae7284edb8 rename api docs to internals před 8 roky
internals_midi_device.md ae7284edb8 rename api docs to internals před 8 roky
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals před 8 roky
internals_midi_util.md ae7284edb8 rename api docs to internals před 8 roky
internals_send_functions.md ae7284edb8 rename api docs to internals před 8 roky
internals_sysex_tools.md ae7284edb8 rename api docs to internals před 8 roky
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) před 5 roky
keycodes.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) před 5 roky
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) před 5 roky
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) před 6 roky
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) před 6 roky
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) před 5 roky
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers před 6 roky
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) před 5 roky
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) před 5 roky
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) před 6 roky
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) před 6 roky
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) před 6 roky
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers před 6 roky
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
one_shot_keys.md c00a9937f2 [Docs] Update one_shot_keys.md (#12291) před 5 roky
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) před 5 roky
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) před 5 roky
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) před 5 roky
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) před 6 roky
power.txt bb53635f33 Trim trailing whitespace před 8 roky
pr_checklist.md 268d0efa7e [Docs] pr_checklist: fix capitalization of Vial (#13301) před 5 roky
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) před 5 roky
qmk.css ccc87421e7 Some more tweaks to make everything look nice před 8 roky
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) před 5 roky
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers před 6 roky
redirects.json d569f08771 Configuration system for CLI (#6708) před 7 roky
ref_functions.md bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) před 5 roky
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop před 5 roky
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) před 5 roky
serial_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) před 5 roky
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop před 5 roky
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) před 6 roky
sw.js 303f425c6b Fix up info boxes. před 8 roky
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) před 6 roky
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) před 5 roky
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) před 6 roky
uart_driver.md 30b46fad57 UART driver refactor (#11637) před 5 roky
understanding_qmk.md d1806a26e4 Split transport mirror (#11046) před 5 roky
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) před 5 roky
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores před 9 roky
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) před 5 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.