You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
umi 808aab8496
add japanese translation (feature part 01) (#8196)
2 years ago
..
ChangeLog 2020 February 29 Breaking Changes Update (#8064) 2 years ago
de Add explicit id tags to externally linked headers 2 years ago
es Add explicit id tags to externally linked headers 2 years ago
fr-fr Add explicit id tags to externally linked headers 2 years ago
gitbook/images RGB improvements (#1684) 4 years ago
he-il Add explicit id tags to externally linked headers 2 years ago
ja add japanese translation (feature part 01) (#8196) 2 years ago
pt-br Add explicit id tags to externally linked headers 2 years ago
ru-ru Add explicit id tags to externally linked headers 2 years ago
zh-cn Add explicit id tags to externally linked headers 2 years ago
.nojekyll Use docsfy to replace gitbook 4 years ago
CNAME Create CNAME 3 years ago
README.md make sure all our redirects are in order 2 years ago
_langs.md [Docs] add README translation in portuguese (#7016) 2 years ago
_summary.md Add Word Per Minute calculation feature (#8054) 2 years ago
adc_driver.md ARM - ADC cleanup (#8385) 2 years ago
api_development_environment.md Add API documentation 2 years ago
api_development_overview.md Add API documentation 2 years ago
api_docs.md Add API documentation 2 years ago
api_overview.md Add API documentation 2 years ago
arm_debugging.md [Docs] fix docs (#7642) 2 years ago
breaking_changes.md Fix the Breaking Changes doc again 2 years ago
breaking_changes_instructions.md suggestions by skullydazed 2 years ago
cli.md [Docs] Random Fixes (#8340) 2 years ago
cli_commands.md Document 'make all:<name>' (#8439) 2 years ago
cli_configuration.md Fix some broken links in the docs (#8394) 2 years ago
cli_development.md Add flake8 to our test suite and fix all errors (#7379) 2 years ago
coding_conventions_c.md Minor grammar and filename fixes in docs (#7559) 2 years ago
coding_conventions_python.md Add a note explaining how to run tests 2 years ago
compatible_microcontrollers.md [Doc] Tidy up compatible MCUs docs (#7295) 2 years ago
config_options.md Feature: RGBLight layers (#7768) 2 years ago
configurator_step_by_step.md Polish Configurator section 2 years ago
configurator_troubleshooting.md Polish Configurator section 2 years ago
contributing.md Add explicit id tags to externally linked headers 2 years ago
custom_matrix.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 2 years ago
custom_quantum_functions.md Add explicit id tags to externally linked headers 2 years ago
documentation_best_practices.md Fix up info boxes. 4 years ago
documentation_templates.md Add explicit id tags to externally linked headers 2 years ago
driver_installation_zadig.md Add a short explanation to Zadig the troubleshooting section (#7110) 2 years ago
eeprom_driver.md Add support for STM32L0/L1 onboard EEPROM. (#8002) 2 years ago
faq_build.md [Docs] Update macOS related issues in docs (#7744) 2 years ago
faq_debug.md [Docs] Remove some outdated FAQ items (#7607) 2 years ago
faq_general.md Rework the newbs guide around the qmk cli 2 years ago
faq_keymap.md make custom_keycode_names.md a faq entry instead 2 years ago
feature_advanced_keycodes.md [Docs] Update layer documentation (#8371) 2 years ago
feature_audio.md Added keycodes for swapping and unswapping the Control and OS keys (#6110) 2 years ago
feature_auto_shift.md Smallish overhaul of Auto-Shift feature (#6067) 2 years ago
feature_backlight.md Add explicit id tags to externally linked headers 2 years ago
feature_bluetooth.md Update feature_bluetooth.md (#7193) 2 years ago
feature_bootmagic.md Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 2 years ago
feature_combo.md Change "yu" to "you" in combo docs (#6510) 2 years ago
feature_command.md Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 2 years ago
feature_debounce_type.md Update debounce docs (#7355) 2 years ago
feature_dip_switch.md Add Dip Switch as a core feature (#6140) 2 years ago
feature_dynamic_macros.md [Core] Convert Dynamic Macro to a Core Feature (#5948) 2 years ago
feature_encoders.md 2020 February 29 Breaking Changes Update (#8064) 2 years ago
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) 3 years ago
feature_haptic_feedback.md Minor grammar and filename fixes in docs (#7559) 2 years ago
feature_hd44780.md Remove build option firmware size impacts (#6947) 2 years ago
feature_key_lock.md Add explicit id tags to externally linked headers 2 years ago
feature_layers.md [Docs] Update layer documentation (#8371) 2 years ago
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 3 years ago
feature_leader_key.md [Docs] Update layer documentation (#8371) 2 years ago
feature_led_matrix.md Add documentation for led matrix 3 years ago
feature_macros.md Add Post Processing to process_record (#4892) 2 years ago
feature_mouse_keys.md Decouple mouse cursor and mouse wheel in accelerated mode (#6685) 2 years ago
feature_oled_driver.md Adding OLED scroll setup functions (#8386) 2 years ago
feature_pointing_device.md [Docs] Random Fixes (#8340) 2 years ago
feature_ps2_mouse.md [Docs] Random Fixes (#8340) 2 years ago
feature_rgb_matrix.md [Docs] Update RGB Matrix docs with function refs (#8367) 2 years ago
feature_rgblight.md [Docs] Fixes for feature_rgblight.md (#8514) 2 years ago
feature_space_cadet.md Added mod carry over from press to release. (#5866) 2 years ago
feature_split_keyboard.md Reduce SPLIT_USB_TIMEOUT by 500ms (#7637) 2 years ago
feature_stenography.md [Docs] Random Fixes (#8340) 2 years ago
feature_swap_hands.md fix swap_hands keycodes in documentation (#3588) 3 years ago
feature_tap_dance.md Add explicit id tags to externally linked headers 2 years ago
feature_terminal.md Remove build option firmware size impacts (#6947) 2 years ago
feature_thermal_printer.md Format keycode tables 4 years ago
feature_unicode.md Rename UC_OSX (and related constants) to UC_MAC (#8589) 2 years ago
feature_userspace.md Document 'make all:<name>' (#8439) 2 years ago
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 3 years ago
feature_wpm.md Add Word Per Minute calculation feature (#8054) 2 years ago
flashing.md update flashing.md 2 years ago
flashing_bootloadhid.md Install bootloadHid as part of qmk_install (#7463) 2 years ago
fuse.txt convert docs to lowercase and underscores 4 years ago
getting_started_github.md Restore getting_started_github.md doc 2 years ago
getting_started_introduction.md [Docs] update git command and directory name of documents (#7619) 2 years ago
getting_started_make_guide.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 2 years ago
getting_started_vagrant.md [Docs] Update getting_started_vagrant.md (#7203) 2 years ago
hand_wire.md make sure all our redirects are in order 2 years ago
hardware_avr.md Remove apostrophe from various abbreviations' plural forms (#7050) 2 years ago
hardware_drivers.md Add customisable EEPROM driver selection (#7274) 2 years ago
hardware_keyboard_guidelines.md [Docs] added the description of the reading order of the rules.mk files. (#8566) 2 years ago
how_a_matrix_works.md refactor How a Matrix Works doc 2 years ago
how_keyboards_work.md Update URL for `60-keyboard.hwdb` (#7185) 2 years ago
i2c_driver.md [Docs] Random Fixes (#8340) 2 years ago
index.html Fix some broken links in the docs (#8394) 2 years ago
internals_defines.md rename api docs to internals 4 years ago
internals_gpio_control.md [Docs] Random Fixes (#8340) 2 years ago
internals_input_callback_reg.md rename api docs to internals 4 years ago
internals_midi_device.md rename api docs to internals 4 years ago
internals_midi_device_setup_process.md rename api docs to internals 4 years ago
internals_midi_util.md rename api docs to internals 4 years ago
internals_send_functions.md rename api docs to internals 4 years ago
internals_sysex_tools.md rename api docs to internals 4 years ago
isp_flashing_guide.md [Docs] Update ISP Flashing guide (#8149) 2 years ago
keycodes.md Rename UC_OSX (and related constants) to UC_MAC (#8589) 2 years ago
keycodes_basic.md Remove obsolete note about media keys in MacOS (#6631) 2 years ago
keycodes_us_ansi_shifted.md Backslash-escape pipe character in keycode lists (#7157) 2 years ago
keymap.md Add explicit id tags to externally linked headers 2 years ago
mod_tap.md break feature_advanced_keycodes.md up into multiple files 2 years ago
newbs.md overhaul the newbs guide 2 years ago
newbs_building_firmware.md Add explicit id tags to externally linked headers 2 years ago
newbs_building_firmware_configurator.md Polish Configurator section 2 years ago
newbs_flashing.md Add explicit id tags to externally linked headers 2 years ago
newbs_getting_started.md Update newbs_getting_started.md 2 years ago
newbs_git_best_practices.md [Docs] Restructure of Git Best Practices doc (#7231) 2 years ago
newbs_git_resolving_merge_conflicts.md [Docs] Restructure of Git Best Practices doc (#7231) 2 years ago
newbs_git_resynchronize_a_branch.md [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 2 years ago
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 2 years ago
newbs_learn_more_resources.md overhaul the newbs guide 2 years ago
newbs_testing_debugging.md Add explicit id tags to externally linked headers 2 years ago
one_shot_keys.md break feature_advanced_keycodes.md up into multiple files 2 years ago
other_eclipse.md fix two links on docs/other_eclipse.md (#8417) 2 years ago
other_vscode.md [Docs] Add VSCode guide to docs (#5124) 3 years ago
power.txt Trim trailing whitespace 4 years ago
proton_c_conversion.md Update feature support for Proton C (#7596) 2 years ago
qmk.css Some more tweaks to make everything look nice 4 years ago
qmk_custom_dark.css Fix darkmode (#8393) 2 years ago
qmk_custom_light.css Fix darkmode (#8393) 2 years ago
quantum_keycodes.md Add explicit id tags to externally linked headers 2 years ago
redirects.json Configuration system for CLI (#6708) 2 years ago
ref_functions.md Add explicit id tags to externally linked headers 2 years ago
reference_configurator_support.md Polish Configurator section 2 years ago
reference_glossary.md Remove apostrophe from various abbreviations' plural forms (#7050) 2 years ago
reference_info_json.md Add label to the info.json reference 3 years ago
support.md make sure all our redirects are in order 2 years ago
sw.js Fix up info boxes. 4 years ago
tap_hold.md Correct typo in tap_hold.md (#8326) 2 years ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 2 years ago
understanding_qmk.md Add Post Processing to process_record (#4892) 2 years ago
unit_testing.md Add explicit id tags to externally linked headers 2 years ago
usb_nkro.txt convert docs to lowercase and underscores 4 years ago
ws2812_driver.md PWM DMA based RGB Underglow for STM32 (#7928) 2 years ago

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.