Startsida Utforska Hjälp
Logga in
logic855
/
qmk_firmware
spegling av https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Filer Ärenden 0 Wiki
Träd: 217e3a59c4
Grenar Taggar
qmk_firmware
/
docs
peepeetee aa73411c14 Update RGB matrix effects documentation (#12181) 5 år sedan
..
ChangeLog 624359b725 2021 February 27 Breaking Changes Changelog (#11975) 5 år sedan
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
fr-fr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
gitbook 4580d3a730 RGB improvements (#1684) 9 år sedan
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
ja b1a8fafa62 [Docs] Japanese translation of docs/keycodes.md (#10192) 5 år sedan
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 år sedan
CNAME 4d26137e2a Create CNAME 8 år sedan
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 år sedan
_summary.md 624359b725 2021 February 27 Breaking Changes Changelog (#11975) 5 år sedan
adc_driver.md 8a4a0c25fd Change analogRead calls to analogReadPin (#9023) 6 år sedan
api_development_environment.md 99850aabca Add API documentation 6 år sedan
api_development_overview.md 99850aabca Add API documentation 6 år sedan
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 år sedan
audio_driver.md c80e5f9f88 Audio system overhaul (#11820) 5 år sedan
breaking_changes.md 624359b725 2021 February 27 Breaking Changes Changelog (#11975) 5 år sedan
breaking_changes_history.md 624359b725 2021 February 27 Breaking Changes Changelog (#11975) 5 år sedan
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 år sedan
cli.md fcf150bd82 Streamline the macos install process 6 år sedan
cli_commands.md d9785ec313 Improve the compile and flash subcommands (#11334) 5 år sedan
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 år sedan
compatible_microcontrollers.md 620a946d01 Add STM32G431 and STM32G474 board definitions. (#11793) 5 år sedan
config_options.md c80e5f9f88 Audio system overhaul (#11820) 5 år sedan
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 år sedan
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 år sedan
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 år sedan
custom_quantum_functions.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 år sedan
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 år sedan
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 år sedan
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) 5 år sedan
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) 5 år sedan
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
faq_debug.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 5 år sedan
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 år sedan
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
feature_advanced_keycodes.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 år sedan
feature_audio.md c80e5f9f88 Audio system overhaul (#11820) 5 år sedan
feature_auto_shift.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 år sedan
feature_backlight.md d92ffd1157 Adds AT90USB162 support (#11570) 5 år sedan
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 6 år sedan
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 år sedan
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) 5 år sedan
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 år sedan
feature_debounce_type.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) 6 år sedan
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 år sedan
feature_encoders.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 år sedan
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 år sedan
feature_haptic_feedback.md 6a5f29208e [Docs] Update feature_haptic_feedback.md (#11859) 5 år sedan
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 år sedan
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 år sedan
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
feature_layers.md 61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 6 år sedan
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 år sedan
feature_leader_key.md 0752b6b23c [Docs] Small spelling mistake fix in leader keys (#12087) 5 år sedan
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) 5 år sedan
feature_led_matrix.md 9ee1282019 LED Matrix: rename `LED_DRIVER_LED_COUNT` to `DRIVER_LED_TOTAL` (#11858) 5 år sedan
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 år sedan
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 år sedan
feature_oled_driver.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 år sedan
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 5 år sedan
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) 5 år sedan
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 år sedan
feature_rgb_matrix.md aa73411c14 Update RGB matrix effects documentation (#12181) 5 år sedan
feature_rgblight.md 53b96f685d RGBLight: Allow configurable default settings (#11912) 5 år sedan
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
feature_split_keyboard.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 5 år sedan
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) 6 år sedan
feature_tap_dance.md 9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259) 6 år sedan
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 år sedan
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 år sedan
feature_unicode.md bcbcb3d107 Add suggestion for indirect unicode input on Linux (#10854) 5 år sedan
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 år sedan
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 år sedan
feature_wpm.md bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) 6 år sedan
flashing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 år sedan
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 5 år sedan
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 år sedan
getting_started_make_guide.md 7161d65070 Remove FAUXCLICKY feature (deprecated) (#11829) 5 år sedan
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 år sedan
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 år sedan
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) 5 år sedan
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 år sedan
internals_defines.md ae7284edb8 rename api docs to internals 8 år sedan
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 år sedan
internals_midi_device.md ae7284edb8 rename api docs to internals 8 år sedan
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 år sedan
internals_midi_util.md ae7284edb8 rename api docs to internals 8 år sedan
internals_send_functions.md ae7284edb8 rename api docs to internals 8 år sedan
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 år sedan
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 år sedan
keycodes.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 år sedan
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 år sedan
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 år sedan
mod_tap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
newbs_flashing.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
newbs_getting_started.md 162842f16e [Docs] add qmk setup home parameter (#11451) 5 år sedan
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 år sedan
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 år sedan
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 år sedan
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
one_shot_keys.md 078586b21a Update one_shot_keys.md (#10917) 5 år sedan
other_eclipse.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 5 år sedan
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 år sedan
power.txt bb53635f33 Trim trailing whitespace 8 år sedan
pr_checklist.md 94e94ffb5b Recommend use of LED Indicator config (#10895) 5 år sedan
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 år sedan
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 år sedan
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
redirects.json d569f08771 Configuration system for CLI (#6708) 7 år sedan
ref_functions.md bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 5 år sedan
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 år sedan
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 5 år sedan
serial_driver.md 990d5189d1 Configurable serial usart timeout (#11057) 5 år sedan
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 år sedan
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
sw.js 303f425c6b Fix up info boxes. 8 år sedan
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 år sedan
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) 5 år sedan
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 år sedan
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 år sedan
understanding_qmk.md d1806a26e4 Split transport mirror (#11046) 5 år sedan
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 år sedan
ws2812_driver.md 3d70766327 Add BGR byte order for WS2812 drivers (#11562) 5 år sedan

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.