mh
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware/
1
0
Fork 0
Code Issues 0 Projects 0 Releases 1.6k Wiki Activity
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.
12891 Commits
64 Branches
2.2 GiB
 
 
 
 
 
Tree: 5eb4675fda
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '5eb4675fda'
${ noResults }
qmk_firmware/docs
yanekm 29ebb99b1f
fixed link to Eclipse instructions (#9647) 		3 years ago
..
ChangeLog 2020 May 30 Breaking Changes Update (#9215) 3 years ago
de Fix capitalisation of "GitHub" (#9184) 3 years ago
es Fix capitalisation of "GitHub" (#9184) 3 years ago
fr-fr Fix capitalisation of "GitHub" (#9184) 3 years ago
gitbook/images RGB improvements (#1684) 6 years ago
he-il Fix capitalisation of "GitHub" (#9184) 3 years ago
ja [Docs] Japanese translation of docs/compatible_microcontrollers.md (#9518) 3 years ago
pt-br Fix capitalisation of "GitHub" (#9184) 3 years ago
ru-ru Fix capitalisation of "GitHub" (#9184) 3 years ago
zh-cn 2020 May 30 Breaking Changes Update (#9215) 3 years ago
.nojekyll Use docsfy to replace gitbook 6 years ago
CNAME Create CNAME 6 years ago
README.md make sure all our redirects are in order 4 years ago
_langs.md [Docs] add README translation in portuguese (#7016) 4 years ago
_summary.md Add documentation for selecting an Arm MCU (#9046) 3 years ago
adc_driver.md adds support for the atmega328 (#9043) 3 years ago
api_development_environment.md Add API documentation 4 years ago
api_development_overview.md Add API documentation 4 years ago
api_docs.md Add API documentation 4 years ago
api_overview.md Add API documentation 4 years ago
arm_debugging.md [Docs] fix docs (#7642) 4 years ago
breaking_changes.md 2020 May 30 Breaking Changes Update (#9215) 3 years ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 3 years ago
cli.md Streamline the macos install process 4 years ago
cli_commands.md [CLI] Add a subcommand for getting information about a keyboard (#8666) 3 years ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 3 years ago
cli_development.md Fix capitalisation of "GitHub" (#9184) 3 years ago
coding_conventions_c.md Update C coding conventions to match .clang-format config for i… (#8717) 4 years ago
coding_conventions_python.md Move everything to Python 3.6 (#8835) 4 years ago
compatible_microcontrollers.md adds support for the atmega328 (#9043) 3 years ago
config_options.md add SPLIT_HAND_MATRIX_GRID support (#8685) 3 years ago
configurator_step_by_step.md Fix capitalisation of "GitHub" (#9184) 3 years ago
configurator_troubleshooting.md Polish Configurator section 4 years ago
contributing.md Add explicit id tags to externally linked headers 4 years ago
custom_matrix.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 4 years ago
custom_quantum_functions.md 2020 May 30 Breaking Changes Update (#9215) 3 years ago
documentation_best_practices.md [Docs] fix file path (#9540) 3 years ago
documentation_templates.md Add explicit id tags to externally linked headers 4 years ago
driver_installation_zadig.md Add a short explanation to Zadig the troubleshooting section (#7110) 4 years ago
eeprom_driver.md Add SPI 25xx EEPROM support. (#8780) 4 years ago
faq_build.md [Docs] Update udev rules to use TAG+="uaccess". (#8750) 3 years ago
faq_debug.md Remove Atmel FLIP from install scripts and documentation (#8822) 4 years ago
faq_general.md Rework the newbs guide around the qmk cli 4 years ago
faq_keymap.md make custom_keycode_names.md a faq entry instead 4 years ago
feature_advanced_keycodes.md Add *OPT aliases for *ALT keycodes and macros (#8714) 4 years ago
feature_audio.md Added keycodes for swapping and unswapping the Control and OS keys (#6110) 4 years ago
feature_auto_shift.md Smallish overhaul of Auto-Shift feature (#6067) 4 years ago
feature_backlight.md Backlight docs wordsmithing (#9631) 3 years ago
feature_bluetooth.md Update feature_bluetooth.md (#7193) 4 years ago
feature_bootmagic.md Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 4 years ago
feature_combo.md Change "yu" to "you" in combo docs (#6510) 4 years ago
feature_command.md Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 4 years ago
feature_debounce_type.md quantum/debounce: Added sym_pk debounce algorithm (#8587) 4 years ago
feature_dip_switch.md add DIP_SWITCH_MATRIX_GRID support (#8772) 3 years ago
feature_dynamic_macros.md [Core] Convert Dynamic Macro to a Core Feature (#5948) 4 years ago
feature_encoders.md Adding information to feature_encoders.md (#9486) 3 years ago
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) 5 years ago
feature_haptic_feedback.md Minor grammar and filename fixes in docs (#7559) 4 years ago
feature_hd44780.md fixed typo for clear lcd screen function in hd44780 docs (#9086) 4 years ago
feature_key_lock.md Add explicit id tags to externally linked headers 4 years ago
feature_layers.md fixed the layer limit of LT() (#9492) 3 years ago
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 5 years ago
feature_leader_key.md Delete trailing period in documentation (#9416) 3 years ago
feature_led_matrix.md Add documentation for led matrix 5 years ago
feature_macros.md [Docs] Improve Unicode documentation (#8676) 3 years ago
feature_mouse_keys.md Decouple mouse cursor and mouse wheel in accelerated mode (#6685) 4 years ago
feature_oled_driver.md Adding OLED scroll setup functions (#8386) 4 years ago
feature_pointing_device.md Include `pointing_device_send` in docs (#9185) 3 years ago
feature_ps2_mouse.md Add movement hook to ps2_mouse (#8805) 3 years ago
feature_rawhid.md Allow for overriding RAW endpoint usage page and ID. (#8834) 3 years ago
feature_rgb_matrix.md Improve keycode handling for RGB (#7677) 3 years ago
feature_rgblight.md Improve keycode handling for RGB (#7677) 3 years ago
feature_space_cadet.md Added mod carry over from press to release. (#5866) 4 years ago
feature_split_keyboard.md add SPLIT_HAND_MATRIX_GRID support (#8685) 3 years ago
feature_stenography.md [Docs] Random Fixes (#8340) 4 years ago
feature_swap_hands.md One shot support for swap hands (#8590) 4 years ago
feature_tap_dance.md Clean up Tap Dance docs (#9372) 3 years ago
feature_terminal.md Remove build option firmware size impacts (#6947) 4 years ago
feature_thermal_printer.md Format keycode tables 6 years ago
feature_unicode.md [Docs] Improve Unicode documentation (#8676) 3 years ago
feature_userspace.md [Docs] Fixed the hyperlink to `/users/_example/`. (#9326) 3 years ago
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 5 years ago
feature_wpm.md Add Word Per Minute calculation feature (#8054) 4 years ago
flashing.md Remove Atmel FLIP from install scripts and documentation (#8822) 4 years ago
flashing_bootloadhid.md Install bootloadHid as part of qmk_install (#7463) 4 years ago
fuse.txt convert docs to lowercase and underscores 6 years ago
getting_started_docker.md Reintegrate previous docker docs (#9084) 4 years ago
getting_started_github.md Fix capitalisation of "GitHub" (#9184) 3 years ago
getting_started_introduction.md [Docs] update git command and directory name of documents (#7619) 4 years ago
getting_started_make_guide.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 4 years ago
getting_started_vagrant.md Remove Atmel FLIP from install scripts and documentation (#8822) 4 years ago
hand_wire.md make sure all our redirects are in order 4 years ago
hardware_avr.md Remove apostrophe from various abbreviations' plural forms (#7050) 4 years ago
hardware_drivers.md Add customisable EEPROM driver selection (#7274) 4 years ago
hardware_keyboard_guidelines.md [Docs] added the description of the reading order of the rules.mk files. (#8566) 4 years ago
how_a_matrix_works.md refactor How a Matrix Works doc 4 years ago
how_keyboards_work.md Update URL for `60-keyboard.hwdb` (#7185) 4 years ago
i2c_driver.md [Docs] Random Fixes (#8340) 4 years ago
index.html Add redirect for old getting started links (#8987) 4 years ago
internals_defines.md rename api docs to internals 6 years ago
internals_gpio_control.md add 'togglePin' convenience function (#8734) 4 years ago
internals_input_callback_reg.md rename api docs to internals 6 years ago
internals_midi_device.md rename api docs to internals 6 years ago
internals_midi_device_setup_process.md rename api docs to internals 6 years ago
internals_midi_util.md rename api docs to internals 6 years ago
internals_send_functions.md rename api docs to internals 6 years ago
internals_sysex_tools.md rename api docs to internals 6 years ago
isp_flashing_guide.md Improve stock bootloader list (#9067) 4 years ago
keycodes.md Add OS compatibility matrix for basic keycodes (#8557) 3 years ago
keycodes_basic.md Add *OPT aliases for *ALT keycodes and macros (#8714) 4 years ago
keycodes_us_ansi_shifted.md Backslash-escape pipe character in keycode lists (#7157) 4 years ago
keymap.md [Docs] Clarify layer transparency keymap.md (#9081) 4 years ago
mod_tap.md Add *OPT aliases for *ALT keycodes and macros (#8714) 4 years ago
newbs.md overhaul the newbs guide 4 years ago
newbs_building_firmware.md Add explicit id tags to externally linked headers 4 years ago
newbs_building_firmware_configurator.md Polish Configurator section 4 years ago
newbs_flashing.md [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 3 years ago
newbs_getting_started.md Update newbs MSYS2 pacman instructions (#9445) 3 years ago
newbs_git_best_practices.md [Docs] Restructure of Git Best Practices doc (#7231) 4 years ago
newbs_git_resolving_merge_conflicts.md [Docs] Restructure of Git Best Practices doc (#7231) 4 years ago
newbs_git_resynchronize_a_branch.md [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 4 years ago
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 4 years ago
newbs_learn_more_resources.md overhaul the newbs guide 4 years ago
newbs_testing_debugging.md Add explicit id tags to externally linked headers 4 years ago
one_shot_keys.md [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380) 3 years ago
other_eclipse.md fix two links on docs/other_eclipse.md (#8417) 4 years ago
other_vscode.md Fix capitalisation of "GitHub" (#9184) 3 years ago
platformdev_chibios_earlyinit.md Add support for hardware and board initialisation overrides. (#8330) 4 years ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 3 years ago
power.txt Trim trailing whitespace 6 years ago
proton_c_conversion.md Update ARM split keyboard docs (#9160) 3 years ago
qmk.css Some more tweaks to make everything look nice 6 years ago
qmk_custom_dark.css Fix darkmode (#8393) 4 years ago
qmk_custom_light.css Fix darkmode (#8393) 4 years ago
quantum_keycodes.md Add explicit id tags to externally linked headers 4 years ago
redirects.json Configuration system for CLI (#6708) 4 years ago
ref_functions.md Fix a couple of typos that were causing confusion (#8767) 4 years ago
reference_configurator_support.md Polish Configurator section 4 years ago
reference_glossary.md fixed link to Eclipse instructions (#9647) 3 years ago
reference_info_json.md Add label to the info.json reference 5 years ago
reference_keymap_extras.md feat: add dvorak-fr as extra keymap (#9512) 3 years ago
serial_driver.md Update ARM split keyboard docs (#9160) 3 years ago
spi_driver.md adds support for the atmega328 (#9043) 3 years ago
support.md Fix capitalisation of "GitHub" (#9184) 3 years ago
sw.js Fix up info boxes. 6 years ago
syllabus.md [Docs] Fixed minor typos (#8860) 4 years ago
tap_hold.md 2020 May 30 Breaking Changes Update (#9215) 3 years ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 4 years ago
understanding_qmk.md Add Post Processing to process_record (#4892) 4 years ago
unit_testing.md Edit Unit Testing Documentation (#8961) 4 years ago
usb_nkro.txt convert docs to lowercase and underscores 6 years ago
ws2812_driver.md Fix incorrect delay when setting WS2812 (and similar) leds (#9302) 3 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.