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

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.