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: d27ab328dc
Branches Tags
qmk_firmware
/
docs
QMK Bot 600faab707 Merge remote-tracking branch 'origin/master' into develop vor 5 Jahren
..
ChangeLog 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) vor 5 Jahren
de fdcea06336 CLI/Docs: Fix the format commands' name (#13668) vor 5 Jahren
es b021c2f2c5 Port new_keyboard.sh to CLI (#13706) vor 5 Jahren
fr-fr fdcea06336 CLI/Docs: Fix the format commands' name (#13668) vor 5 Jahren
gitbook 4580d3a730 RGB improvements (#1684) vor 9 Jahren
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
ja 70fb3e1aaf __flash? (#13799) vor 5 Jahren
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
zh-cn b73a29aaea [Bug] Develop - Change uint32_t to layer_state_t (#13596) vor 5 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 52cfc9259b [Feature] Key Overrides (#11422) vor 5 Jahren
adc_driver.md 65c9752762 Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) 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 c80e5f9f88 Audio system overhaul (#11820) vor 5 Jahren
breaking_changes.md e3030bff5e Merge remote-tracking branch 'upstream/master' into develop vor 5 Jahren
breaking_changes_history.md 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) 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 b021c2f2c5 Port new_keyboard.sh to CLI (#13706) vor 5 Jahren
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
cli_development.md fdcea06336 CLI/Docs: Fix the format commands' name (#13668) 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 8bb231aa1c Adds support for STM32L412xB, STM32L422xB. (#13383) vor 5 Jahren
config_options.md 52cfc9259b [Feature] Key Overrides (#11422) vor 5 Jahren
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) vor 6 Jahren
custom_quantum_functions.md f287597c19 Use single memcmp to determine if matrix changed. (#13064) vor 5 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 71e9f8fc11 Update LUFA (18-07-2021) and add QMK-HID Bootloader support (#13588) 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 fc9fb2c775 Allow output of logging when running unit tests (#13556) vor 5 Jahren
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) vor 5 Jahren
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) vor 5 Jahren
feature_audio.md 2538d341d8 Document user song list file (#13101) vor 5 Jahren
feature_auto_shift.md c02137a0d2 Add Per Key functionality for AutoShift (#11536) vor 5 Jahren
feature_backlight.md 06aea834c4 Backlight: add defines for default level and breathing state (#12560) vor 5 Jahren
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) vor 6 Jahren
feature_bootmagic.md fd9d531bd9 [Docs] Remove extra word it bootmagic page (#13855) vor 5 Jahren
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) vor 5 Jahren
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) vor 7 Jahren
feature_debounce_type.md a0959f1b33 Add asym_eager_defer_pk debounce type (#12689) vor 5 Jahren
feature_dip_switch.md d972919204 [Docs] Fix typo in dip switch example (#13688) vor 5 Jahren
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) vor 6 Jahren
feature_encoders.md a0fed0ea17 Convert Encoder callbacks to be boolean functions (#12805) vor 5 Jahren
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) vor 7 Jahren
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) vor 5 Jahren
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) vor 6 Jahren
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
feature_key_overrides.md 52cfc9259b [Feature] Key Overrides (#11422) 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 40e67a3074 Add a mechanism for force building a particular community layout (#5027) vor 7 Jahren
feature_leader_key.md 26b9b3aa23 feat: infinite timeout for leader key (#6580) vor 5 Jahren
feature_led_indicators.md 8f6867ce95 [Docs] Added note about no split support (#12512) vor 5 Jahren
feature_led_matrix.md 70fb3e1aaf __flash? (#13799) vor 5 Jahren
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) vor 5 Jahren
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) vor 5 Jahren
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) vor 5 Jahren
feature_oled_driver.md 0311c8036d Add oled_invert (#13172) vor 5 Jahren
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop vor 5 Jahren
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) vor 5 Jahren
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) vor 5 Jahren
feature_rgb_matrix.md 70fb3e1aaf __flash? (#13799) 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 550d9253b0 Allow invert of SPLIT_HAND_PIN logic (#13433) vor 5 Jahren
feature_st7565.md 37fba09021 ST7565 invert (#13237) vor 5 Jahren
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
feature_swap_hands.md f0b30e0027 Make Swap Hands use PROGMEM (#12284) vor 5 Jahren
feature_tap_dance.md 03d258c222 matrix_scan_x -> x_task (#13748) vor 5 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 04ab5de73c Deprecate `send_unicode_hex_string()` (#12602) vor 5 Jahren
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) vor 5 Jahren
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) vor 7 Jahren
feature_wpm.md 180a32ec59 Enhancement of WPM feature (#11727) vor 5 Jahren
flashing.md 71e9f8fc11 Update LUFA (18-07-2021) and add QMK-HID Bootloader support (#13588) vor 5 Jahren
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) vor 6 Jahren
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) vor 5 Jahren
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) vor 6 Jahren
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) vor 5 Jahren
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 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 d13ada1162 Add customisable EEPROM driver selection (#7274) vor 6 Jahren
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) vor 6 Jahren
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) vor 5 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 fa309df895 [Docs] added list of MIDI keycodes (#13159) vor 5 Jahren
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 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 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) vor 5 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 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) vor 6 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 9c69db4700 Updated settings.json file to fit VSC's docs (#13829) 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 b459f314ec Explicitly state that VIA should not be enabled in the default keymap. (#13803) vor 5 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 bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
reference_info_json.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) vor 5 Jahren
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) vor 5 Jahren
serial_driver.md 117bff17ba [Core] Unite half-duplex and full-duplex serial drivers (#13081) 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 52cfc9259b [Feature] Key Overrides (#11422) vor 5 Jahren
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) 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 52cfc9259b [Feature] Key Overrides (#11422) vor 5 Jahren
unit_testing.md fc9fb2c775 Allow output of logging when running unit tests (#13556) vor 5 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.