Zach White 5abe666749 Merge remote-tracking branch 'origin/master' into develop 5 лет назад
..
ChangeLog 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
de 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
es 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
fr-fr 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
gitbook 4580d3a730 RGB improvements (#1684) 9 лет назад
he-il 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
ja 415d683ea7 Remove unused `action_get_macro()` usages in user files (#11165) 5 лет назад
ko-kr cb80b59e93 Adding few Korean translated files (#5895) 5 лет назад
pt-br e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
ru-ru e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
zh-cn 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 лет назад
CNAME 4d26137e2a Create CNAME 8 лет назад
README.md b2ab0af905 [Docs] Update links in main README.md (#11284) 5 лет назад
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 лет назад
_summary.md a15c9057a1 Document how to add data driven configurations (#11502) 5 лет назад
adc_driver.md 8a4a0c25fd Change analogRead calls to analogReadPin (#9023) 6 лет назад
api_development_environment.md 99850aabca Add API documentation 6 лет назад
api_development_overview.md 99850aabca Add API documentation 6 лет назад
api_docs.md 99850aabca Add API documentation 6 лет назад
api_overview.md 99850aabca Add API documentation 6 лет назад
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 лет назад
breaking_changes.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 лет назад
cli.md fcf150bd82 Streamline the macos install process 6 лет назад
cli_commands.md d9785ec313 Improve the compile and flash subcommands (#11334) 5 лет назад
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
coding_conventions_c.md f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717) 6 лет назад
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 лет назад
compatible_microcontrollers.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 лет назад
config_options.md 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 лет назад
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 лет назад
contributing.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 лет назад
custom_quantum_functions.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
data_driven_config.md a15c9057a1 Document how to add data driven configurations (#11502) 5 лет назад
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 лет назад
documentation_templates.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) 5 лет назад
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) 5 лет назад
faq_build.md 7d5ba88e6f 50-qmk.rules: Move udev rules from documentation into a file (#10664) 5 лет назад
faq_debug.md 72b1ff5899 Add TMK "FEED" VID to list of deprecated udev rules 6 лет назад
faq_general.md a701c15d87 Rework the newbs guide around the qmk cli 6 лет назад
faq_keymap.md 12e43230c6 make custom_keycode_names.md a faq entry instead 6 лет назад
feature_advanced_keycodes.md 0cb7133e0d Doc followup 9942 (#10473) 5 лет назад
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 лет назад
feature_auto_shift.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_backlight.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 лет назад
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 лет назад
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) 5 лет назад
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 лет назад
feature_debounce_type.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) 6 лет назад
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 лет назад
feature_encoders.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 лет назад
feature_haptic_feedback.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 лет назад
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
feature_layers.md 61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 6 лет назад
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 лет назад
feature_leader_key.md 294cfd8d33 Delete trailing period in documentation (#9416) 6 лет назад
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) 5 лет назад
feature_led_matrix.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_macros.md 415d683ea7 Remove unused `action_get_macro()` usages in user files (#11165) 5 лет назад
feature_mouse_keys.md 010271d6ea Implement kinetic mouse movement algorithm (#6739) 5 лет назад
feature_oled_driver.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
feature_pointing_device.md 573d1fbb92 Include `pointing_device_send` in docs (#9185) 6 лет назад
feature_ps2_mouse.md b7dc2eb9ab Add movement hook to ps2_mouse (#8805) 6 лет назад
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 лет назад
feature_rgb_matrix.md ca7da3866d Merge remote-tracking branch 'upstream/master' into develop 5 лет назад
feature_rgblight.md 837aa75666 Merge remote-tracking branch 'origin/master' into develop 5 лет назад
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
feature_space_cadet.md d16db69367 Added mod carry over from press to release. (#5866) 7 лет назад
feature_split_keyboard.md 5e2b53541b Add modifier state to the split keyboard transport (#10400) 5 лет назад
feature_stenography.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) 6 лет назад
feature_tap_dance.md 9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259) 6 лет назад
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 лет назад
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 лет назад
feature_unicode.md b5c2e5e8fd Fix documentation so UCIS example compiles. (#11541) 5 лет назад
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 лет назад
feature_wpm.md bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) 6 лет назад
flashing.md d00ac5dfb6 Add `st-flash` flash target (#9964) 6 лет назад
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 лет назад
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
getting_started_docker.md 0fbcb41c85 Reintegrate previous docker docs (#9084) 6 лет назад
getting_started_github.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 лет назад
getting_started_make_guide.md 0f596881b3 Remove support for Adafruit EZ-Key (#10103) 6 лет назад
getting_started_vagrant.md bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822) 6 лет назад
hand_wire.md 988715910c [Docs] Fix typo in hand_wire.md (#11297) 5 лет назад
hardware_avr.md efbaf68d5a Fix documentation of `lsusb` behaviour (#10903) 5 лет назад
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 лет назад
hardware_keyboard_guidelines.md 4d33d72975 New command: qmk lint (#10761) 5 лет назад
how_a_matrix_works.md a95a314f78 refactor How a Matrix Works doc 6 лет назад
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 лет назад
i2c_driver.md 346bfb2a05 Update i2c_driver.md (#10131) 6 лет назад
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 лет назад
internals_defines.md ae7284edb8 rename api docs to internals 8 лет назад
internals_gpio_control.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_device.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 лет назад
internals_midi_util.md ae7284edb8 rename api docs to internals 8 лет назад
internals_send_functions.md ae7284edb8 rename api docs to internals 8 лет назад
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 лет назад
isp_flashing_guide.md c4d778a302 [Docs] Update ISP Guide (#9748) 6 лет назад
keycodes.md 962b8d3814 Update keycode docs (#11343) 5 лет назад
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 лет назад
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 лет назад
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 лет назад
mod_tap.md 139d28eaae [Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548) 5 лет назад
newbs.md 489bee0ee4 [Docs] redirect from /tutorial to /newbs (#10718) 5 лет назад
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
newbs_building_firmware_configurator.md d5f34c4810 Polish Configurator section 6 лет назад
newbs_flashing.md 9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 6 лет назад
newbs_getting_started.md 95a1496ebc Fix AUR package name (#11416) 5 лет назад
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 лет назад
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 лет назад
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
newbs_learn_more_resources.md 45e218ceec overhaul the newbs guide 6 лет назад
newbs_testing_debugging.md 501f2fdef1 Normalise include statements in core code (#11153) 5 лет назад
one_shot_keys.md 078586b21a Update one_shot_keys.md (#10917) 5 лет назад
other_eclipse.md cde5237a88 fix two links on docs/other_eclipse.md (#8417) 6 лет назад
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 5 лет назад
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 лет назад
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 лет назад
power.txt bb53635f33 Trim trailing whitespace 8 лет назад
pr_checklist.md 94e94ffb5b Recommend use of LED Indicator config (#10895) 5 лет назад
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 лет назад
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 лет назад
qmk_custom_dark.css bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 лет назад
qmk_custom_light.css bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 лет назад
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 лет назад
redirects.json d569f08771 Configuration system for CLI (#6708) 7 лет назад
ref_functions.md 2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370) 5 лет назад
reference_configurator_support.md d5f34c4810 Polish Configurator section 6 лет назад
reference_glossary.md 29ebb99b1f fixed link to Eclipse instructions (#9647) 6 лет назад
reference_info_json.md 962bc8d9dd Use the schema to eliminate custom code (#11108) 5 лет назад
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 5 лет назад
serial_driver.md 990d5189d1 Configurable serial usart timeout (#11057) 5 лет назад
spi_driver.md 7aa4cc9603 adds support for the atmega328 (#9043) 6 лет назад
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 лет назад
sw.js 303f425c6b Fix up info boxes. 8 лет назад
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 лет назад
tap_hold.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 лет назад
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 лет назад
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) 6 лет назад
unit_testing.md e02a3c559d Edit Unit Testing Documentation (#8961) 6 лет назад
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 лет назад
ws2812_driver.md 3d70766327 Add BGR byte order for WS2812 drivers (#11562) 5 лет назад

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.