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: 54ef02dead
Branches Tags
qmk_firmware
/
docs
umi 044b4aaf01 [Docs] Japanese translation of docs/feature_split_keyboard.md (#9031) vor 6 Jahren
..
ChangeLog fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 Jahren
de e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
es e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
fr-fr e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
gitbook 4580d3a730 RGB improvements (#1684) vor 9 Jahren
he-il e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
ja 044b4aaf01 [Docs] Japanese translation of docs/feature_split_keyboard.md (#9031) vor 6 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 fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 Jahren
.nojekyll 9e5676650e Use docsfy to replace gitbook vor 8 Jahren
CNAME 4d26137e2a Create CNAME vor 8 Jahren
README.md 961477c791 make sure all our redirects are in order vor 6 Jahren
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) vor 6 Jahren
_summary.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) vor 6 Jahren
adc_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) 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 fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 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 751316c344 [CLI] Add a subcommand for getting information about a keyboard (#8666) vor 6 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 e2e287ec5f Option to allow lighting layers when RGB Lighting is off (#9051) vor 6 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 fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 Jahren
documentation_best_practices.md 303f425c6b Fix up info boxes. vor 8 Jahren
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
driver_installation_zadig.md 80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110) vor 6 Jahren
eeprom_driver.md 54b04d9665 Add SPI 25xx EEPROM support. (#8780) vor 6 Jahren
faq_build.md b9a38487f3 [Docs] Update udev rules to use TAG+="uaccess". (#8750) vor 6 Jahren
faq_debug.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 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 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) vor 6 Jahren
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) vor 7 Jahren
feature_auto_shift.md e9c44e396d Smallish overhaul of Auto-Shift feature (#6067) vor 6 Jahren
feature_backlight.md 7aa4cc9603 adds support for the atmega328 (#9043) vor 6 Jahren
feature_bluetooth.md 908aede957 Update feature_bluetooth.md (#7193) vor 6 Jahren
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) vor 6 Jahren
feature_combo.md 57540af102 Change "yu" to "you" in combo docs (#6510) vor 7 Jahren
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) vor 7 Jahren
feature_debounce_type.md b8c3f4c60b quantum/debounce: Added sym_pk debounce algorithm (#8587) vor 6 Jahren
feature_dip_switch.md dab4967f1b Add Dip Switch as a core feature (#6140) vor 7 Jahren
feature_dynamic_macros.md 542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948) vor 6 Jahren
feature_encoders.md bafa35ff46 fix sample code indent in feature_encoders.md (#8883) vor 6 Jahren
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) vor 7 Jahren
feature_haptic_feedback.md f275ffbdfc Minor grammar and filename fixes in docs (#7559) vor 6 Jahren
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) vor 6 Jahren
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
feature_layers.md 5df2424651 [Docs] Update layer documentation (#8371) 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 5df2424651 [Docs] Update layer documentation (#8371) vor 6 Jahren
feature_led_matrix.md 24df54b807 Add documentation for led matrix vor 7 Jahren
feature_macros.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) vor 6 Jahren
feature_mouse_keys.md 3cd2a27ac0 Decouple mouse cursor and mouse wheel in accelerated mode (#6685) vor 6 Jahren
feature_oled_driver.md b5be96f8bb Adding OLED scroll setup functions (#8386) vor 6 Jahren
feature_pointing_device.md 573d1fbb92 Include `pointing_device_send` in docs (#9185) vor 6 Jahren
feature_ps2_mouse.md 07c75feba3 Add PS2_MOUSE_ROTATE to compensate for device orientation (#8650) vor 6 Jahren
feature_rawhid.md d1df576ece Allow for overriding RAW endpoint usage page and ID. (#8834) vor 6 Jahren
feature_rgb_matrix.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 Jahren
feature_rgblight.md e2e287ec5f Option to allow lighting layers when RGB Lighting is off (#9051) vor 6 Jahren
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) vor 7 Jahren
feature_split_keyboard.md 6d84795bc1 Update ARM split keyboard docs (#9160) vor 6 Jahren
feature_stenography.md b272c035ba [Docs] Random Fixes (#8340) vor 6 Jahren
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) vor 6 Jahren
feature_tap_dance.md 54c58ea6de Add explicit id tags to externally linked headers 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 bdfdc506da Rename UC_OSX (and related constants) to UC_MAC (#8589) vor 6 Jahren
feature_userspace.md 2543bad250 [Docs] Fixed the hyperlink to `/users/_example/`. (#9326) vor 6 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 bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) vor 6 Jahren
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) vor 6 Jahren
fuse.txt ca01d94005 convert docs to lowercase and underscores vor 9 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 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) vor 6 Jahren
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) vor 6 Jahren
hand_wire.md 961477c791 make sure all our redirects are in order vor 6 Jahren
hardware_avr.md f87908228a Remove apostrophe from various abbreviations' plural forms (#7050) vor 6 Jahren
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) vor 6 Jahren
hardware_keyboard_guidelines.md dc98d44582 [Docs] added the description of the reading order of the rules.mk files. (#8566) vor 6 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 b272c035ba [Docs] Random Fixes (#8340) vor 6 Jahren
index.html e182a38e7c Add redirect for old getting started links (#8987) vor 6 Jahren
internals_defines.md ae7284edb8 rename api docs to internals vor 8 Jahren
internals_gpio_control.md d26a14c169 add 'togglePin' convenience function (#8734) vor 6 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 f66850bfd0 Improve stock bootloader list (#9067) vor 6 Jahren
keycodes.md 3736db6081 Add OS compatibility matrix for basic keycodes (#8557) vor 6 Jahren
keycodes_basic.md 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) vor 6 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 370577e4ed Add *OPT aliases for *ALT keycodes and macros (#8714) vor 6 Jahren
newbs.md 45e218ceec overhaul the newbs guide vor 6 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 0cb4da2c74 Really fix Ubuntu/Debian setup when $PATH contains spaces (#9370) vor 6 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 54c58ea6de Add explicit id tags to externally linked headers vor 6 Jahren
one_shot_keys.md 9035c3497e break feature_advanced_keycodes.md up into multiple files vor 6 Jahren
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) vor 6 Jahren
other_vscode.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
platformdev_chibios_earlyinit.md 05e9ff6554 Add support for hardware and board initialisation overrides. (#8330) vor 6 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
proton_c_conversion.md 6d84795bc1 Update ARM split keyboard docs (#9160) vor 6 Jahren
qmk.css ccc87421e7 Some more tweaks to make everything look nice vor 8 Jahren
qmk_custom_dark.css 1b267d4840 Fix darkmode (#8393) vor 6 Jahren
qmk_custom_light.css 1b267d4840 Fix darkmode (#8393) vor 6 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 6 Jahren
ref_functions.md 750179e111 Fix a couple of typos that were causing confusion (#8767) vor 6 Jahren
reference_configurator_support.md d5f34c4810 Polish Configurator section vor 6 Jahren
reference_glossary.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) vor 6 Jahren
reference_info_json.md bcb1815420 Add label to the info.json reference vor 7 Jahren
reference_keymap_extras.md 4f6f7b59cf `French (Belgium)` was missing (#9245) vor 6 Jahren
serial_driver.md 6d84795bc1 Update ARM split keyboard docs (#9160) vor 6 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 fced377ac0 2020 May 30 Breaking Changes Update (#9215) vor 6 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 f74c769a19 PWM DMA based RGB Underglow for STM32 (#7928) vor 6 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.