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: 5b2feecdf3
Branches Tags
qmk_firmware
/
docs
Joshua Diamond e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) vor 5 Jahren
..
ChangeLog 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
de 501f2fdef1 Normalise include statements in core code (#11153) vor 5 Jahren
es 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
fr-fr 501f2fdef1 Normalise include statements in core code (#11153) vor 5 Jahren
gitbook 4580d3a730 RGB improvements (#1684) vor 9 Jahren
he-il 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
ja 09eb6381a9 Merge remote-tracking branch 'origin/master' into develop vor 5 Jahren
ko-kr cb80b59e93 Adding few Korean translated files (#5895) vor 5 Jahren
pt-br e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
ru-ru e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
zh-cn 501f2fdef1 Normalise include statements in core code (#11153) vor 5 Jahren
.nojekyll 9e5676650e Use docsfy to replace gitbook vor 8 Jahren
CNAME 4d26137e2a Create CNAME vor 8 Jahren
README.md b2ab0af905 [Docs] Update links in main README.md (#11284) vor 5 Jahren
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) vor 6 Jahren
_summary.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
adc_driver.md 8a4a0c25fd Change analogRead calls to analogReadPin (#9023) vor 6 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 99850aabca Add API documentation vor 6 Jahren
api_overview.md 99850aabca Add API documentation vor 6 Jahren
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
breaking_changes.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 Jahren
cli.md fcf150bd82 Streamline the macos install process vor 6 Jahren
cli_commands.md 6890090fbb Updated usage of qmk c2json (#11148) vor 5 Jahren
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
coding_conventions_c.md f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717) vor 6 Jahren
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) vor 6 Jahren
compatible_microcontrollers.md 7aa4cc9603 adds support for the atmega328 (#9043) vor 6 Jahren
config_options.md 501f2fdef1 Normalise include statements in core code (#11153) 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 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) vor 6 Jahren
custom_quantum_functions.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) vor 6 Jahren
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) vor 5 Jahren
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) vor 5 Jahren
faq_build.md 7d5ba88e6f 50-qmk.rules: Move udev rules from documentation into a file (#10664) vor 5 Jahren
faq_debug.md 72b1ff5899 Add TMK "FEED" VID to list of deprecated udev rules vor 6 Jahren
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli vor 6 Jahren
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead vor 6 Jahren
feature_advanced_keycodes.md 0cb7133e0d Doc followup 9942 (#10473) vor 5 Jahren
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) vor 7 Jahren
feature_auto_shift.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
feature_backlight.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 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 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) vor 6 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 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) vor 6 Jahren
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) vor 6 Jahren
feature_encoders.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 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_layers.md 61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) vor 6 Jahren
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) vor 7 Jahren
feature_leader_key.md 294cfd8d33 Delete trailing period in documentation (#9416) vor 6 Jahren
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) vor 5 Jahren
feature_led_matrix.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
feature_macros.md 3300164065 Typo fix: Useful function -> Useful Functions (#11342) vor 5 Jahren
feature_mouse_keys.md 010271d6ea Implement kinetic mouse movement algorithm (#6739) vor 5 Jahren
feature_oled_driver.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
feature_pointing_device.md 573d1fbb92 Include `pointing_device_send` in docs (#9185) vor 6 Jahren
feature_ps2_mouse.md b7dc2eb9ab Add movement hook to ps2_mouse (#8805) vor 6 Jahren
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) vor 5 Jahren
feature_rgb_matrix.md 4f2f21dc05 Rewrite APA102 support (#10894) vor 5 Jahren
feature_rgblight.md 4f2f21dc05 Rewrite APA102 support (#10894) vor 5 Jahren
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) vor 7 Jahren
feature_split_keyboard.md 5e2b53541b Add modifier state to the split keyboard transport (#10400) vor 5 Jahren
feature_stenography.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) vor 6 Jahren
feature_tap_dance.md 9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259) vor 6 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 02781979d6 [Docs] Improve Unicode documentation (#8676) vor 6 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 bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) vor 6 Jahren
flashing.md d00ac5dfb6 Add `st-flash` flash target (#9964) vor 6 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 0fbcb41c85 Reintegrate previous docker docs (#9084) vor 6 Jahren
getting_started_github.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) vor 6 Jahren
getting_started_make_guide.md 0f596881b3 Remove support for Adafruit EZ-Key (#10103) vor 6 Jahren
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) vor 6 Jahren
hand_wire.md 988715910c [Docs] Fix typo in hand_wire.md (#11297) vor 5 Jahren
hardware_avr.md 72d3270547 Remove `DESCRIPTION` (#9732) vor 6 Jahren
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) vor 6 Jahren
hardware_keyboard_guidelines.md 4d33d72975 New command: qmk lint (#10761) vor 5 Jahren
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc vor 6 Jahren
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) vor 6 Jahren
i2c_driver.md 346bfb2a05 Update i2c_driver.md (#10131) vor 6 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 c66df16644 2020 November 28 Breaking Changes Update (#11053) 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 c4d778a302 [Docs] Update ISP Guide (#9748) vor 6 Jahren
keycodes.md 962b8d3814 Update keycode docs (#11343) 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 139d28eaae [Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548) vor 5 Jahren
newbs.md 489bee0ee4 [Docs] redirect from /tutorial to /newbs (#10718) vor 5 Jahren
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section vor 6 Jahren
newbs_flashing.md 9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) vor 6 Jahren
newbs_getting_started.md 6f6e28b4c7 Add Arch / Manjaro section for Linux setup instructions (#10509) 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 45e218ceec overhaul the newbs guide vor 6 Jahren
newbs_testing_debugging.md 501f2fdef1 Normalise include statements in core code (#11153) vor 5 Jahren
one_shot_keys.md 078586b21a Update one_shot_keys.md (#10917) vor 5 Jahren
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) vor 6 Jahren
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 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 94e94ffb5b Recommend use of LED Indicator config (#10895) 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 bbf0f65284 Simplify the visual flow of the getting started page (#11316) vor 5 Jahren
qmk_custom_light.css bbf0f65284 Simplify the visual flow of the getting started page (#11316) 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 2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370) vor 6 Jahren
reference_configurator_support.md d5f34c4810 Polish Configurator section vor 6 Jahren
reference_glossary.md 29ebb99b1f fixed link to Eclipse instructions (#9647) vor 6 Jahren
reference_info_json.md 47b9b11009 Configure keyboard matrix from info.json (#10817) 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 990d5189d1 Configurable serial usart timeout (#11057) vor 5 Jahren
spi_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) vor 6 Jahren
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
sw.js 303f425c6b Fix up info boxes. vor 8 Jahren
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) vor 6 Jahren
tap_hold.md c66df16644 2020 November 28 Breaking Changes Update (#11053) vor 5 Jahren
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) vor 6 Jahren
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) vor 6 Jahren
unit_testing.md e02a3c559d Edit Unit Testing Documentation (#8961) vor 6 Jahren
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores vor 9 Jahren
ws2812_driver.md c59f87a5d7 add definition WS2812_BYTE_ORDER to fix RGB LED issues (#10184) vor 5 Jahren

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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

Totally new to QMK? There are two ways to get started:

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.