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.
15874 Commits
65 Branches
1.6 GiB
 
 
 
 
 
Tree: ec78f8bca2
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ec78f8bca2'
${ noResults }
qmk_firmware/docs
Ryan 6c550cc7f7
Improve driver installation docs (#13562) 		2 years ago
..
ChangeLog 2021 May 29 Breaking Changes Update (#13034) 2 years ago
de [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
es [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
fr-fr Cleanup junk characters, part 1 (#13282) 2 years ago
gitbook/images RGB improvements (#1684) 6 years ago
he-il [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
ja Remove unwanted notes (#13563) 2 years ago
ko-kr [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
pt-br [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
ru-ru [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
zh-cn [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
.nojekyll Use docsfy to replace gitbook 6 years ago
CNAME Create CNAME 5 years ago
README.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
_langs.md [Docs] add README translation in portuguese (#7016) 4 years ago
_summary.md [Docs] added basic midi documention of common features (#13113) 2 years ago
adc_driver.md 2021 May 29 Breaking Changes Update (#13034) 2 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 [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
api_overview.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
arm_debugging.md [Docs] fix docs (#7642) 4 years ago
audio_driver.md Audio system overhaul (#11820) 3 years ago
breaking_changes.md Update merge sequence to reflect no-ff, no-squash. (#13038) 2 years ago
breaking_changes_history.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 3 years ago
cli.md Streamline the macos install process 3 years ago
cli_commands.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 3 years ago
cli_development.md Fix capitalisation of "GitHub" (#9184) 3 years ago
cli_tab_complete.md Add support for tab completion (#12411) 3 years ago
coding_conventions_c.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
coding_conventions_python.md Move everything to Python 3.6 (#8835) 4 years ago
compatible_microcontrollers.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
config_options.md [Docs] Fix typos in audio config in main config page (#12928) 2 years ago
configurator_default_keymaps.md [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 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 [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
custom_matrix.md Add docs for 'CUSTOM_MATRIX = lite' (#7906) 4 years ago
custom_quantum_functions.md 2020 November 28 Breaking Changes Update (#11053) 3 years ago
data_driven_config.md Create a system to map between info.json and config.h/rules.mk (#11548) 3 years ago
documentation_best_practices.md [Docs] fix file path (#9540) 3 years ago
documentation_templates.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
driver_installation_zadig.md Improve driver installation docs (#13562) 2 years ago
eeprom_driver.md Add i2c 24LC64 eeprom (#11200) 3 years ago
faq_build.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
faq_debug.md Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 3 years ago
faq_general.md Fix typos and reword some sentences in FAQs (#11546) 3 years ago
faq_keymap.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
faq_misc.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
feature_advanced_keycodes.md Additional documentation for GUI mod combo (#13266) 2 years ago
feature_audio.md Document user song list file (#13101) 2 years ago
feature_auto_shift.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_backlight.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_bluetooth.md Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 3 years ago
feature_bootmagic.md Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 4 years ago
feature_combo.md changed type of process_combo_event argument in tutorial (#10621) 3 years ago
feature_command.md Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 4 years ago
feature_debounce_type.md Ensure single newline at EOF for core files (#11310) 3 years ago
feature_dip_switch.md add DIP_SWITCH_MATRIX_GRID support (#8772) 3 years ago
feature_dynamic_macros.md Fix typo in docs/feature_dynamic_macros (#10085) 3 years ago
feature_encoders.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_grave_esc.md Document an annoyance with Grave Escape and macOS Terminal (#5483) 5 years ago
feature_haptic_feedback.md [Docs] Update feature_haptic_feedback.md (#11859) 3 years ago
feature_hd44780.md fixed typo for clear lcd screen function in hd44780 docs (#9086) 3 years ago
feature_joystick.md 2020 November 28 Breaking Changes Update (#11053) 3 years ago
feature_key_lock.md Add explicit id tags to externally linked headers 4 years ago
feature_layers.md Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 3 years ago
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 5 years ago
feature_leader_key.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_led_indicators.md Indicator LEDs as config (#10816) 3 years ago
feature_led_matrix.md Top level heading for common config (LED Matrix) (#13153) 2 years ago
feature_macros.md [Docs] New section to modifier docs: Checking Modifier State (#10550) 3 years ago
feature_midi.md [Docs] added basic midi documention of common features (#13113) 2 years ago
feature_mouse_keys.md Add support for 8 buttons to mouse report (#10807) 3 years ago
feature_oled_driver.md OLED driver tweaks (#13215) 2 years ago
feature_pointing_device.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_ps2_mouse.md fix(feature_ps2_mouse): fix Scroll Button example (#11669) 3 years ago
feature_rawhid.md Updated Raw HID docs to clarify packet/report length (#11211) 3 years ago
feature_rgb_matrix.md [Docs] RGB Matrix Caps Lock and Layer indicator example (#13367) 2 years ago
feature_rgblight.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_sequencer.md Ensure single newline at EOF for core files (#11310) 3 years ago
feature_space_cadet.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
feature_split_keyboard.md [Docs] Update feature_split_keyboard.md (#13205) 2 years ago
feature_stenography.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
feature_swap_hands.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_tap_dance.md More Tap Dance docs improvements (#12358) 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 2021 May 29 Breaking Changes Update (#13034) 2 years ago
feature_userspace.md Normalise include statements in core code (#11153) 3 years ago
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 5 years ago
feature_wpm.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
flashing.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
flashing_bootloadhid.md Install bootloadHid as part of qmk_install (#7463) 4 years ago
fuse.txt Ensure single newline at EOF for core files (#11310) 3 years ago
getting_started_docker.md Add support for using podman to util/docker_build.sh (#10819) 3 years ago
getting_started_github.md [Docs] Use HTTPS for images and links where possible (#11695) 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 Documentation update (#12484) 3 years ago
getting_started_vagrant.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
hand_wire.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
hardware_avr.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
hardware_drivers.md Add customisable EEPROM driver selection (#7274) 4 years ago
hardware_keyboard_guidelines.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
how_a_matrix_works.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
how_keyboards_work.md Update URL for `60-keyboard.hwdb` (#7185) 4 years ago
i2c_driver.md Rework I2C driver docs (#11658) 3 years ago
index.html Simplify the visual flow of the getting started page (#11316) 3 years ago
internals_defines.md rename api docs to internals 6 years ago
internals_gpio_control.md [Docs] Use HTTPS for images and links where possible (#11695) 3 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 [Docs] Update isp_flashing_guide.md (#11777) 3 years ago
keycodes.md [Docs] added list of MIDI keycodes (#13159) 2 years ago
keycodes_basic.md Update keycode docs (#11343) 3 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) 3 years ago
mod_tap.md Add Mac centric Shift and Alt + GUI Macros (#13107) 2 years ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
newbs_building_firmware.md Add explicit id tags to externally linked headers 4 years ago
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
newbs_flashing.md A few small typo fixes in docs (#12524) 3 years ago
newbs_getting_started.md Update FreeBSD install method (#12815) 2 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 Small tweaks to docs to make them more user friendly (#11518) 3 years ago
newbs_testing_debugging.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
one_shot_keys.md [Docs] Update one_shot_keys.md (#12291) 2 years ago
other_eclipse.md eclipse: recommend changing the default project make target (#12447) 3 years ago
other_vscode.md Update other_vscode.md of Japanese document (#10604) 3 years ago
platformdev_chibios_earlyinit.md Ensure single newline at EOF for core files (#11310) 3 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
pr_checklist.md [Docs] pr_checklist: fix capitalization of Vial (#13301) 2 years ago
proton_c_conversion.md Add board specific to Proton-C, with usual defaults turned on. (#10976) 3 years ago
qmk.css Some more tweaks to make everything look nice 6 years ago
qmk_custom_dark.css Small tweaks to docs to make them more user friendly (#11518) 3 years ago
qmk_custom_light.css Small tweaks to docs to make them more user friendly (#11518) 3 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 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 3 years ago
reference_configurator_support.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
reference_glossary.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
reference_info_json.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
reference_keymap_extras.md Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 3 years ago
serial_driver.md 2021 May 29 Breaking Changes Update (#13034) 2 years ago
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 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 Update IGNORE_MOD_TAP_INTERRUPT (#11452) 3 years ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 4 years ago
uart_driver.md UART driver refactor (#11637) 3 years ago
understanding_qmk.md Split transport mirror (#11046) 3 years ago
unit_testing.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
usb_nkro.txt convert docs to lowercase and underscores 6 years ago
ws2812_driver.md Fix up WS2812 SPI driver on F072. (#13022) 2 years ago

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
User friendly graphical interfaces, no programming knowledge required.

?> Advanced Use The Source
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.