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

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.