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.
24975 Commits
65 Branches
21 GiB
 
 
 
 
 
Tree: 1e2deddd43
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1e2deddd43'
${ noResults }
qmk_firmware/docs
precondition 1e2deddd43
Remove outdated remarks regarding the default MT behavior (#21077) 		11 months ago
..
ChangeLog `develop` 2023q2 changelog (#21049) 11 months ago
gitbook/images RGB improvements (#1684) 6 years ago
internals Move Doxygen docs to subdirectory (#16561) 2 years ago
ja [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 11 months ago
zh-cn [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 11 months ago
.nojekyll Use docsfy to replace gitbook 6 years ago
CNAME Create CNAME 6 years ago
README.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
_langs.md Remove stale docs translations (#15737) 2 years ago
_summary.md Update "Most Recent ChangeLog" (#21071) 11 months ago
adc_driver.md Add analog support for RP2040 (#19453) 1 year ago
api_development_environment.md Add API documentation 4 years ago
api_development_overview.md Add API documentation 4 years ago
api_docs.md 2022 Nov 26 changelog. (#19164) 1 year 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 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 1 year ago
breaking_changes.md `develop` 2023q2 changelog (#21049) 11 months ago
breaking_changes_history.md `develop` 2023q2 changelog (#21049) 11 months ago
breaking_changes_instructions.md `develop` 2023q2 changelog (#21049) 11 months ago
chibios_upgrade_instructions.md Update branch names to reflect configurator's new deployment. (#19999) 1 year ago
cli.md Streamline the macos install process 4 years ago
cli_commands.md `qmk find`: usability improvements (#20440) 11 months ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 4 years ago
cli_development.md docs: some typos (#18582) 1 year ago
cli_tab_complete.md Add Zsh note for tab complete (#17226) 1 year ago
coding_conventions_c.md docs: some typos (#18582) 1 year ago
coding_conventions_python.md docs: some typos (#18582) 1 year ago
compatible_microcontrollers.md Tentative Teensy 3.5 support (#14420) 1 year ago
config_options.md Keymap introspection for combos. (#19670) 1 year ago
configurator_architecture.md Architecture documentation for Configurator and API (#13935) 2 years ago
configurator_default_keymaps.md Reallocate SAFE_RANGE (#19909) 1 year ago
configurator_diagram.drawio Architecture documentation for Configurator and API (#13935) 2 years ago
configurator_diagram.svg Architecture documentation for Configurator and API (#13935) 2 years ago
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 2 years ago
configurator_troubleshooting.md Polish Configurator section 4 years ago
contributing.md Minor cleanup to breaking/checklist docs. (#19596) 1 year ago
custom_matrix.md Remove matrix_init_quantum/matrix_scan_quantum (#19806) 1 year ago
custom_quantum_functions.md [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 1 year ago
data_driven_config.md Format DD mappings and schemas (#18924) 1 year ago
documentation_best_practices.md [Docs] fix file path (#9540) 3 years ago
documentation_templates.md [Docs] Touch up documentation templates & porting keyboard docs (#19573) 1 year ago
driver_installation_zadig.md [Docs] RESET -> QK_BOOT (#18365) 1 year ago
easy_maker.md update the Chinese translation based on the latest English version (#14924) 2 years ago
eeprom_driver.md RP2040 emulated EEPROM. (#17519) 1 year ago
faq_build.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
faq_debug.md Remove legacy Debug keycode (#18769) 1 year ago
faq_general.md Fix typos and reword some sentences in FAQs (#11546) 3 years ago
faq_keymap.md Keymap FAQ updates (#17130) 2 years ago
faq_misc.md [Docs] RESET -> QK_BOOT (#18365) 1 year ago
feature_advanced_keycodes.md Update code example to match description (#20528) 1 year ago
feature_audio.md Align audio keycode names (#18962) 1 year ago
feature_auto_shift.md Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY (#15741) 1 year ago
feature_autocorrect.md Document Autocorrect callback functions (#20115) 1 year ago
feature_backlight.md Reworked backlight keycodes. (#18961) 1 year ago
feature_bluetooth.md Normalise output selection (Bluetooth) keycodes (#19004) 1 year ago
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 2 years ago
feature_caps_word.md [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 1 year ago
feature_combo.md Keymap introspection for combos. (#19670) 1 year ago
feature_command.md Remove Full Bootmagic (#13846) 2 years ago
feature_converters.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
feature_debounce_type.md Add debounce time description (#20333) 1 year ago
feature_digitizer.md Digitizer feature improvements (#19034) 1 year ago
feature_dip_switch.md Added right vs left specific pin assignments for dip switch (#13074) 2 years ago
feature_dynamic_macros.md Add direction to dynamic_macro_record_start_user (#19689) 1 year ago
feature_eeprom.md Remove rgblight_list.h (#18878) 1 year ago
feature_encoders.md Encodermap direction define. (#20454) 1 year ago
feature_grave_esc.md Rename some Quantum keycodes (#15968) 2 years ago
feature_haptic_feedback.md Align haptic feedback keycode names (#18964) 1 year ago
feature_hd44780.md HD44780 driver rework (#16370) 2 years ago
feature_joystick.md [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) 1 year ago
feature_key_lock.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
feature_key_overrides.md [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 1 year ago
feature_layers.md Add layer-cycle example (#19069) 1 year ago
feature_layouts.md [Docs] Clean up some code block languages (#14434) 2 years ago
feature_leader_key.md Refactor Leader key feature (#19632) 1 year ago
feature_led_indicators.md Remove deprecated led_set_kb (#19273) 1 year ago
feature_led_matrix.md [Bug] Realign and size check EECONFIG structures (#20541) 1 year ago
feature_macros.md Macro keycode name refactoring (#18958) 1 year ago
feature_midi.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
feature_mouse_keys.md add "inertia" mode for mouse keys (#18774) 1 year ago
feature_oled_driver.md OLED Driver improvements (#20331) 1 year ago
feature_os_detection.md Detect host OS based on USB fingerprint (#18463) 1 year ago
feature_pointing_device.md Make Pointing Device Auto Layer more configurable (#20061) 1 year ago
feature_programmable_button.md Normalise Joystick and Programmable Button keycodes (#18832) 1 year ago
feature_ps2_mouse.md [Core] Rework PS/2 driver selection (#17892) 1 year ago
feature_rawhid.md [Docs] Clean up some code block languages (#14434) 2 years ago
feature_repeat_key.md [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 11 months ago
feature_rgb_matrix.md [Bug] Realign and size check EECONFIG structures (#20541) 1 year ago
feature_rgblight.md Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 1 year ago
feature_secure.md Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 1 year ago
feature_send_string.md Feature-ify Send String (#17275) 1 year ago
feature_sequencer.md Align sequencer keycodes (#19875) 1 year ago
feature_space_cadet.md Use wayback machine for unreachable site (#20987) 11 months ago
feature_split_keyboard.md Sync activity timestamps between sides. (#20192) 1 year ago
feature_st7565.md ST7565 invert (#13237) 2 years ago
feature_stenography.md [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847) 1 year ago
feature_swap_hands.md Add swap hands toggle functions (#20381) 1 year ago
feature_tap_dance.md Tap Dance: remove `qk_` prefix (#19313) 1 year ago
feature_tri_layer.md [Core] Tri Layer Keys (#19795) 1 year ago
feature_unicode.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
feature_userspace.md Enable CLI flashing via mdloader (#14729) 2 years ago
feature_velocikey.md Deprecate `VLK_TOG` for `VK_TOGG` (#18807) 1 year ago
feature_wpm.md Fix typo in `feature_wpm.md` title (#20464) 1 year ago
flash_driver.md Added external spi flash driver. (#15419) 2 years ago
flashing.md Add f303 to tinyuf2 bootloader support (#19620) 1 year ago
flashing_bootloadhid.md [Docs] RESET -> QK_BOOT (#18365) 1 year ago
fuse.txt Ensure single newline at EOF for core files (#11310) 3 years ago
getting_started_docker.md [Docs] Clean up some code block languages (#14434) 2 years ago
getting_started_github.md Purge uGFX. (#14720) 2 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 support for deferred executors. (#14859) 2 years ago
gpio_control.md Fix functions with empty params (#19647) 1 year ago
hand_wire.md Improve importer workflow (#17707) 1 year ago
hardware_drivers.md Purge uGFX. (#14720) 2 years ago
hardware_keyboard_guidelines.md Merge remote-tracking branch 'origin/master' into develop 1 year ago
how_a_matrix_works.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
how_keyboards_work.md docs: reflect systemd's change in language (#17322) 1 year ago
i2c_driver.md Fix i2c driver doc: Incorrect name (#16898) 2 years ago
index.html Fix anchors with <code> in table of content (#15169) 2 years ago
isp_flashing_guide.md Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 1 year ago
keycodes.md [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 11 months ago
keycodes_basic.md Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 1 year ago
keycodes_magic.md Align magic keycodes (#19877) 1 year ago
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
keymap.md [Docs] Change defines to enums in examples (#19793) 1 year ago
mod_tap.md Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 1 year ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 3 years ago
newbs_building_firmware.md Align new-keymap with new-keyboard (#19229) 1 year ago
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
newbs_building_firmware_workflow.md Update qmk_cli container references (#20154) 1 year ago
newbs_flashing.md Add note about qmk doctor in newbs_flashing.md (#15688) 1 year ago
newbs_getting_started.md Suggest `qmk list-keyboards` when testing build environment (#19471) 1 year 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] Resynchronizing Your Branch including submodules (#19268) 1 year ago
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 4 years ago
newbs_learn_more_resources.md [Docs] Refactor code examples (#18003) 1 year ago
newbs_testing_debugging.md Small tweaks to docs to make them more user friendly (#11518) 3 years ago
one_shot_keys.md fix typo (#19189) 1 year ago
other_eclipse.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2 years ago
other_vscode.md Far better VSCode intellisense support using clangd. (#20382) 1 year ago
platformdev_blackpill_f4x1.md Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 1 year ago
platformdev_chibios_earlyinit.md [Docs] RESET -> QK_BOOT (#18365) 1 year ago
platformdev_proton_c.md Add converter docs (#17593) 1 year ago
platformdev_rp2040.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 1 year ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 3 years ago
porting_your_keyboard_to_qmk.md [Docs] Discuss layout macro (#19803) 1 year ago
power.txt Trim trailing whitespace 6 years ago
pr_checklist.md `develop` 2023q2 changelog (#21049) 11 months 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 ability to enter bootloader mode from `QK_MAKE` (#17745) 1 year ago
quantum_painter.md [Feature] Disable debug on QP's internal task (#20623) 1 year ago
quantum_painter_lvgl.md Fix functions with empty params (#19647) 1 year ago
quantum_painter_qff.md Quantum Painter (#10174) 2 years ago
quantum_painter_qgf.md Quantum Painter (#10174) 2 years ago
quantum_painter_rle.md Quantum Painter (#10174) 2 years ago
redirects.json Configuration system for CLI (#6708) 4 years ago
ref_functions.md Remove legacy EEPROM clear keycodes (#18782) 1 year ago
reference_configurator_support.md Basic keycode overhaul (#14726) 2 years ago
reference_glossary.md Fix Space Cadet md link (#14300) 2 years ago
reference_info_json.md Remove `all` from list of animations in `info.json` (#19978) 1 year ago
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 2 years ago
serial_driver.md Fix serial_driver.md list item numbering (#19819) 1 year ago
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 3 years ago
squeezing_avr.md Add RP2040 Community Edition alias for Liatris (#19966) 1 year ago
support.md Fix capitalisation of "GitHub" (#9184) 4 years ago
support_deprecation_policy.md Initial deprecation policy documentation. (#19908) 1 year ago
sw.js Fix up info boxes. 6 years ago
syllabus.md [Docs] Squeezing space out of AVR (#15243) 2 years ago
tap_hold.md Remove outdated remarks regarding the default MT behavior (#21077) 11 months ago
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 4 years ago
uart_driver.md Update UART driver API (#14839) 2 years ago
understanding_qmk.md Move `pre_process_record_kb()` before `process_combo()` (#20969) 11 months ago
unit_testing.md Remove SERIAL_LINK feature (#14727) 2 years ago
usb_nkro.txt convert docs to lowercase and underscores 7 years ago
ws2812_driver.md Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 1 year 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.