hailey
/
qmk_firmware
mirror of https://github.com/hailey/qmk_firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
My local repo of qmk firmware.
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.
25821 Commits
54 Branches
1475 Tags
301 MiB
 
 
 
 
Tag: Branch: Tree: 0edc68f7cd
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0edc68f7cd'
${ noResults }
qmk_firmware/docs
History
Yanfei Guo 17ae28f0e4
Fix doc for programmable buttons. (#22136) 		2 years ago
..
ChangeLog Breaking changes changelog, 2023q3 version (#21848) 2 years ago
gitbook/images
…
internals Move Doxygen docs to subdirectory (#16561) 3 years ago
ja Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 2 years ago
zh-cn [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 2 years ago
.nojekyll
…
CNAME
…
README.md
…
_langs.md
…
_summary.md Move Digitizer to "Software Features" (#22031) 2 years ago
adc_driver.md Add analog support for RP2040 (#19453) 2 years ago
api_development_environment.md
…
api_development_overview.md
…
api_docs.md 2022 Nov 26 changelog. (#19164) 2 years ago
api_overview.md
…
arm_debugging.md
…
audio_driver.md [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 3 years ago
breaking_changes.md Breaking changes changelog, 2023q3 version (#21848) 2 years ago
breaking_changes_history.md Breaking changes changelog, 2023q3 version (#21848) 2 years ago
breaking_changes_instructions.md `develop` 2023q2 changelog (#21049) 2 years ago
chibios_upgrade_instructions.md Update branch names to reflect configurator's new deployment. (#19999) 2 years ago
cli.md
…
cli_commands.md `qmk find`: usability improvements (#20440) 2 years ago
cli_configuration.md
…
cli_development.md docs: some typos (#18582) 3 years ago
cli_tab_complete.md Add Zsh note for tab complete (#17226) 3 years ago
coding_conventions_c.md [Docs] Code markdown amendment (#21323) 2 years ago
coding_conventions_python.md docs: some typos (#18582) 3 years ago
compatible_microcontrollers.md STM32H723 support (#21352) 2 years ago
config_options.md Bluetooth: driver naming cleanups (#21624) 2 years ago
configurator_architecture.md
…
configurator_default_keymaps.md Reallocate SAFE_RANGE (#19909) 2 years ago
configurator_diagram.drawio
…
configurator_diagram.svg
…
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 3 years ago
configurator_troubleshooting.md
…
contributing.md Breaking changes changelog, 2023q3 version (#21848) 2 years ago
custom_matrix.md Remove matrix_init_quantum/matrix_scan_quantum (#19806) 2 years ago
custom_quantum_functions.md [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 2 years ago
data_driven_config.md Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 2 years ago
documentation_best_practices.md
…
documentation_templates.md [Docs] Touch up documentation templates & porting keyboard docs (#19573) 2 years ago
driver_installation_zadig.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
easy_maker.md update the Chinese translation based on the latest English version (#14924) 3 years ago
eeprom_driver.md RP2040 emulated EEPROM. (#17519) 3 years ago
faq_build.md
…
faq_debug.md Remove legacy Debug keycode (#18769) 3 years ago
faq_general.md
…
faq_keymap.md Keymap FAQ updates (#17130) 3 years ago
faq_misc.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
feature_advanced_keycodes.md Update code example to match description (#20528) 2 years ago
feature_audio.md Align audio keycode names (#18962) 3 years ago
feature_auto_shift.md Adds a way to separate tab from AUTO_SHIFT_SPECIAL. (#20996) 2 years ago
feature_autocorrect.md [Enhancement] More info on `apply_autocorrect` (#21056) 2 years ago
feature_backlight.md backlight: split AVR PWM and timer drivers (#21540) 2 years ago
feature_bluetooth.md Bluetooth: driver naming cleanups (#21624) 2 years ago
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 3 years ago
feature_caps_word.md [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 2 years ago
feature_combo.md Keymap introspection for combos. (#19670) 2 years ago
feature_command.md
…
feature_converters.md Merge remote-tracking branch 'origin/master' into develop 2 years ago
feature_debounce_type.md Add debounce time description (#20333) 2 years ago
feature_digitizer.md Digitizer feature improvements (#19034) 3 years ago
feature_dip_switch.md
…
feature_dynamic_macros.md Add direction to dynamic_macro_record_start_user (#19689) 2 years ago
feature_eeprom.md Remove rgblight_list.h (#18878) 3 years ago
feature_encoders.md Encodermap direction define. (#20454) 2 years ago
feature_grave_esc.md Rename some Quantum keycodes (#15968) 3 years ago
feature_haptic_feedback.md haptic: further naming cleanups (#21682) 2 years ago
feature_hd44780.md Fix anchor IDs for some API references (#21345) 2 years ago
feature_joystick.md [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) 2 years ago
feature_key_lock.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_key_overrides.md [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 2 years ago
feature_layers.md Changed interverts to inverts (#21270) 2 years ago
feature_layouts.md
…
feature_leader_key.md Refactor Leader key feature (#19632) 2 years ago
feature_led_indicators.md Remove deprecated led_set_kb (#19273) 2 years ago
feature_led_matrix.md Simplfy RGB/LED matrix effect logic (#21703) 2 years ago
feature_macros.md Corrected duration example, should be number not string (#21839) 2 years ago
feature_midi.md Merge remote-tracking branch 'origin/master' into develop 2 years ago
feature_mouse_keys.md Add MOUSEKEY_WHEEL_DELTA documentation (#21493) 2 years ago
feature_oled_driver.md Fix typo in oled_driver (#22134) 2 years ago
feature_os_detection.md Detect host OS based on USB fingerprint (#18463) 2 years ago
feature_pointing_device.md Make Pointing Device Auto Layer more configurable (#20061) 2 years ago
feature_programmable_button.md Fix doc for programmable buttons. (#22136) 2 years ago
feature_ps2_mouse.md Document the RP2040-specific PS/2 implementation (#22079) 2 years ago
feature_rawhid.md Raw HID: documentation improvements (#21596) 2 years ago
feature_repeat_key.md [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 2 years ago
feature_rgb_matrix.md RGB Matrix: driver naming cleanups (#21594) 2 years ago
feature_rgblight.md Revert "Update feature_rgblight.md" (#22132) 2 years ago
feature_secure.md Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 years ago
feature_send_string.md Fix anchor IDs for some API references (#21345) 2 years ago
feature_sequencer.md Align sequencer keycodes (#19875) 2 years ago
feature_space_cadet.md Use wayback machine for unreachable site (#20987) 2 years ago
feature_split_keyboard.md Sync activity timestamps between sides. (#20192) 2 years ago
feature_st7565.md
…
feature_stenography.md [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847) 2 years ago
feature_swap_hands.md Add swap hands toggle functions (#20381) 2 years ago
feature_tap_dance.md On-each-release tap dance function (#20255) 2 years ago
feature_tri_layer.md [Core] Tri Layer Keys (#19795) 2 years ago
feature_unicode.md Unicode, Unicodemap and UCIS refactor (#21659) 2 years ago
feature_userspace.md
…
feature_velocikey.md Deprecate `VLK_TOG` for `VK_TOGG` (#18807) 3 years ago
feature_wpm.md Fix typo in `feature_wpm.md` title (#20464) 2 years ago
flash_driver.md Added external spi flash driver. (#15419) 3 years ago
flashing.md feat, docs: WB32 flashing (#21217) 2 years ago
flashing_bootloadhid.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
fuse.txt
…
getting_started_docker.md
…
getting_started_github.md
…
getting_started_introduction.md
…
getting_started_make_guide.md Unicodemap keycodes rename (#21092) 2 years ago
gpio_control.md Fix functions with empty params (#19647) 2 years ago
hand_wire.md Improve importer workflow (#17707) 3 years ago
hardware_drivers.md
…
hardware_keyboard_guidelines.md Merge remote-tracking branch 'origin/master' into develop 2 years ago
how_a_matrix_works.md
…
how_keyboards_work.md docs: reflect systemd's change in language (#17322) 3 years ago
i2c_driver.md Fix anchor IDs for some API references (#21345) 2 years ago
index.html Fix anchors with <code> in table of content (#15169) 3 years ago
isp_flashing_guide.md Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 2 years ago
keycodes.md Unicodemap keycodes rename (#21092) 2 years ago
keycodes_basic.md Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 2 years ago
keycodes_magic.md Align magic keycodes (#19877) 2 years ago
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
keymap.md [Docs] Change defines to enums in examples (#19793) 2 years ago
mod_tap.md Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 2 years ago
newbs.md
…
newbs_building_firmware.md Align new-keymap with new-keyboard (#19229) 2 years ago
newbs_building_firmware_configurator.md Update newbs docs with some rp2040 stuff (#21186) 2 years ago
newbs_building_firmware_workflow.md [Docs] Highlight keymap name entry (#21138) 2 years ago
newbs_flashing.md Update newbs docs with some rp2040 stuff (#21186) 2 years ago
newbs_getting_started.md Add an emphasis on QMK MSYS terminal (#21168) 2 years ago
newbs_git_best_practices.md
…
newbs_git_resolving_merge_conflicts.md
…
newbs_git_resynchronize_a_branch.md [Docs] Resynchronizing Your Branch including submodules (#19268) 2 years ago
newbs_git_using_your_master_branch.md
…
newbs_learn_more_resources.md [Docs] Refactor code examples (#18003) 3 years ago
newbs_testing_debugging.md
…
one_shot_keys.md fix typo (#19189) 2 years ago
other_eclipse.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
other_vscode.md Fix VS code live share extension link (#21585) 2 years ago
platformdev_blackpill_f4x1.md Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 2 years ago
platformdev_chibios_earlyinit.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
platformdev_proton_c.md Add converter docs (#17593) 3 years ago
platformdev_rp2040.md Add rp2040_ce and add elite-pi and helios as alias (#19830) 2 years ago
platformdev_selecting_arm_mcu.md
…
porting_your_keyboard_to_qmk.md [Docs] Discuss layout macro (#19803) 2 years ago
power.txt
…
pr_checklist.md Add reminder about format-json to PR Checklist (#22055) 2 years ago
qmk.css
…
qmk_custom_dark.css [Docs] Improve contrast for warnings in dark mode (#21928) 2 years ago
qmk_custom_light.css
…
quantum_keycodes.md [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) 2 years ago
quantum_painter.md [Docs] Fix listed defaults in quantum painter docs (#21429) 2 years ago
quantum_painter_lvgl.md Fix functions with empty params (#19647) 2 years ago
quantum_painter_qff.md Quantum Painter (#10174) 3 years ago
quantum_painter_qgf.md Quantum Painter (#10174) 3 years ago
quantum_painter_rle.md Quantum Painter (#10174) 3 years ago
redirects.json
…
ref_functions.md Remove legacy EEPROM clear keycodes (#18782) 3 years ago
reference_configurator_support.md
…
reference_glossary.md Breaking changes changelog, 2023q3 version (#21848) 2 years ago
reference_info_json.md Rework info.json reference (#21324) 2 years ago
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 3 years ago
serial_driver.md Fix serial_driver.md list item numbering (#19819) 2 years ago
spi_driver.md Fix anchor IDs for some API references (#21345) 2 years ago
squeezing_avr.md [Doc] Improve magic keycode section (#21787) 2 years ago
support.md
…
support_deprecation_policy.md Initial deprecation policy documentation. (#19908) 2 years ago
sw.js
…
syllabus.md
…
tap_hold.md [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 2 years ago
translating.md
…
uart_driver.md Fix anchor IDs for some API references (#21345) 2 years ago
understanding_qmk.md Move `pre_process_record_kb()` before `process_combo()` (#20969) 2 years ago
unit_testing.md
…
usb_nkro.txt
…
ws2812_driver.md Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 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.