Startseite Erkunden Hilfe
Anmelden
logic855
/
qmk_firmware
Mirror von https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Dateien Issues 0 Wiki
Struktur: 3d2bc8ef24
Branches Tags
qmk_firmware
/
docs
QMK Bot 9a20bc1f8f Merge remote-tracking branch 'origin/master' into develop vor 4 Jahren
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) vor 5 Jahren
de 596c4a1f87 Remove bin/qmk (#14231) vor 5 Jahren
es b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
fr-fr b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
gitbook 4580d3a730 RGB improvements (#1684) vor 9 Jahren
he-il b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
ja 9a20bc1f8f Merge remote-tracking branch 'origin/master' into develop vor 4 Jahren
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) vor 5 Jahren
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) vor 5 Jahren
ru-ru b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
zh-cn b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
.nojekyll 9e5676650e Use docsfy to replace gitbook vor 8 Jahren
CNAME 4d26137e2a Create CNAME vor 8 Jahren
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) vor 6 Jahren
_summary.md 83988597f4 Add Support for USB programmable buttons (#12950) vor 5 Jahren
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) vor 5 Jahren
api_development_environment.md 99850aabca Add API documentation vor 6 Jahren
api_development_overview.md 99850aabca Add API documentation vor 6 Jahren
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) vor 5 Jahren
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) vor 5 Jahren
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 Jahren
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) vor 5 Jahren
cli.md fcf150bd82 Streamline the macos install process vor 6 Jahren
cli_commands.md 590b405468 New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) vor 5 Jahren
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) vor 5 Jahren
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) vor 6 Jahren
compatible_microcontrollers.md 1a9e7b95ab Change `MK66F18` -> `MK66FX1M0` (#14659) vor 4 Jahren
config_options.md 02ab7b1888 [Core] Fix "6kro enable" and clarify naming (#14563) vor 4 Jahren
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_default_keymaps.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
configurator_troubleshooting.md d5f34c4810 Polish Configurator section vor 6 Jahren
contributing.md 596c4a1f87 Remove bin/qmk (#14231) vor 5 Jahren
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
custom_quantum_functions.md 45f88af4a1 [Docs] update suspend_*_user examples (#14542) vor 4 Jahren
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) vor 5 Jahren
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) vor 6 Jahren
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
driver_installation_zadig.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) vor 5 Jahren
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) vor 5 Jahren
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) vor 5 Jahren
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
faq_debug.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) vor 5 Jahren
faq_keymap.md bb356a1584 [Docs] Update path to keycode.h (#14263) vor 5 Jahren
faq_misc.md d8f0c8783a Remove sysex API (#14723) vor 4 Jahren
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) vor 5 Jahren
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) vor 5 Jahren
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) vor 5 Jahren
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_bluetooth.md db41a3426c Improve Adafruit BLE configuration defines (#14749) vor 4 Jahren
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) vor 5 Jahren
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) vor 5 Jahren
feature_command.md a03aa301de Remove Full Bootmagic (#13846) vor 5 Jahren
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) vor 5 Jahren
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) vor 5 Jahren
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) vor 6 Jahren
feature_encoders.md 19e33b685f [Docs] Modify encoder_update_user example to return false (#14541) vor 4 Jahren
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) vor 7 Jahren
feature_haptic_feedback.md eb5b24f97c Add LM() keys to the list of keys disabled by NO_HAPTIC_MOD (#14181) vor 4 Jahren
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) vor 6 Jahren
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
feature_key_overrides.md 1e7117317f Documentation: Fix links in key overrides (#14228) vor 5 Jahren
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) vor 5 Jahren
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) vor 5 Jahren
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) vor 5 Jahren
feature_led_matrix.md ddb6821b97 [Docs] fix wrong directory for RGB Matrix animations (#14494) vor 5 Jahren
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) vor 5 Jahren
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) vor 5 Jahren
feature_oled_driver.md 657323a206 [Docs] fixed incorrect amount of steps for oled usage (#13519) vor 5 Jahren
feature_pointing_device.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) vor 5 Jahren
feature_ps2_mouse.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_rgb_matrix.md c38a730805 Merge remote-tracking branch 'upstream/master' into develop vor 5 Jahren
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) vor 5 Jahren
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
feature_split_keyboard.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) vor 5 Jahren
feature_st7565.md 37fba09021 ST7565 invert (#13237) vor 5 Jahren
feature_stenography.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_swap_hands.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_tap_dance.md 13f3e30e86 Fix link from feature_tap_dance.md to tapping term settings (#14741) vor 4 Jahren
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) vor 6 Jahren
feature_thermal_printer.md 4c675a83ba Format keycode tables vor 8 Jahren
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) vor 5 Jahren
feature_userspace.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_velocikey.md 8a8fdd9a72 Highlight keycode (#14317) vor 5 Jahren
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) vor 5 Jahren
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) vor 5 Jahren
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) vor 6 Jahren
getting_started_make_guide.md d8f0c8783a Remove sysex API (#14723) vor 4 Jahren
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) vor 5 Jahren
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) vor 5 Jahren
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) vor 4 Jahren
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) vor 5 Jahren
internals_defines.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
internals_input_callback_reg.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_midi_device.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_midi_util.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_send_functions.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_sysex_tools.md ae7284edb8 rename api docs to internals vor 8 Jahren
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) vor 5 Jahren
keycodes.md 83988597f4 Add Support for USB programmable buttons (#12950) vor 5 Jahren
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) vor 5 Jahren
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) vor 5 Jahren
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) vor 6 Jahren
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) vor 6 Jahren
mod_tap.md 27d9579fd5 Document examples on intercepting Mod-Tap (#14502) vor 4 Jahren
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) vor 5 Jahren
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) vor 5 Jahren
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) vor 6 Jahren
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) vor 5 Jahren
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) vor 5 Jahren
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) vor 5 Jahren
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) vor 6 Jahren
power.txt bb53635f33 Trim trailing whitespace vor 8 Jahren
pr_checklist.md 4676a14596 More PR checklist updates (#14705) vor 4 Jahren
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) vor 5 Jahren
qmk.css ccc87421e7 Some more tweaks to make everything look nice vor 8 Jahren
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
redirects.json d569f08771 Configuration system for CLI (#6708) vor 7 Jahren
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) vor 5 Jahren
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) vor 5 Jahren
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) vor 5 Jahren
reference_info_json.md 4791cfae1a Remove width, height and key_count from info.json (#14274) vor 5 Jahren
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) vor 5 Jahren
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) vor 5 Jahren
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop vor 5 Jahren
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
sw.js 303f425c6b Fix up info boxes. vor 8 Jahren
syllabus.md a03aa301de Remove Full Bootmagic (#13846) vor 5 Jahren
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) vor 5 Jahren
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) vor 6 Jahren
uart_driver.md 30b46fad57 UART driver refactor (#11637) vor 5 Jahren
understanding_qmk.md b2a186cf92 Purge uGFX. (#14720) vor 4 Jahren
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) vor 4 Jahren
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores vor 9 Jahren
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) vor 5 Jahren

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.