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.
22504 Commits
54 Branches
1475 Tags
301 MiB
 
 
 
 
Tag: Branch: Tree: 40aa9c8745
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '40aa9c8745'
${ noResults }
qmk_firmware/docs
History
Peter Hindes 40aa9c8745
spelling fix (#18831) 		3 years ago
..
ChangeLog 2022q3 Changelog. (#18180) 3 years ago
gitbook/images
…
internals Move Doxygen docs to subdirectory (#16561) 3 years ago
ja [Docs] RESET -> QK_BOOT (#18365) 3 years ago
zh-cn [Docs] RESET -> QK_BOOT (#18365) 3 years ago
.nojekyll
…
CNAME
…
README.md Small tweaks to docs to make them more user friendly (#11518) 4 years ago
_langs.md Remove stale docs translations (#15737) 3 years ago
_summary.md [Docs] Update platformdev_blackpill_f411.md (#18666) 3 years ago
adc_driver.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
api_development_environment.md
…
api_development_overview.md
…
api_docs.md docs: some typos (#18582) 3 years ago
api_overview.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
arm_debugging.md
…
audio_driver.md [Docs] Fix tables in Audio driver document (#17780) 3 years ago
breaking_changes.md 2022q3 Changelog. (#18180) 3 years ago
breaking_changes_history.md 2022q3 Changelog. (#18180) 3 years ago
breaking_changes_instructions.md
…
chibios_upgrade_instructions.md Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 years ago
cli.md
…
cli_commands.md docs: some typos (#18582) 3 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: some typos (#18582) 3 years ago
coding_conventions_python.md docs: some typos (#18582) 3 years ago
compatible_microcontrollers.md Tentative Teensy 3.5 support (#14420) 3 years ago
config_options.md docs: some typos (#18582) 3 years ago
configurator_architecture.md Architecture documentation for Configurator and API (#13935) 4 years ago
configurator_default_keymaps.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
configurator_diagram.drawio Architecture documentation for Configurator and API (#13935) 4 years ago
configurator_diagram.svg Architecture documentation for Configurator and API (#13935) 4 years ago
configurator_step_by_step.md update the Chinese translation based on the latest English version (#14924) 3 years ago
configurator_troubleshooting.md
…
contributing.md update the Chinese translation based on the latest English version (#14924) 3 years ago
custom_matrix.md Make debounce() signal changes in the cooked matrix as return value (#17554) 3 years ago
custom_quantum_functions.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 years ago
data_driven_config.md [Docs] Fix typo in data driven config docs (#18095) 3 years ago
documentation_best_practices.md
…
documentation_templates.md [Docs] Fix link to keyboard layout editor (#18801) 3 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 [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
faq_debug.md [Docs] Add a note about the print function. (#17737) 3 years ago
faq_general.md Fix typos and reword some sentences in FAQs (#11546) 4 years ago
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 [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 years ago
feature_audio.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
feature_auto_shift.md Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 years ago
feature_backlight.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_bluetooth.md Rename `AdafruitBLE` to `BluefruitLE` (#16127) 3 years ago
feature_bootmagic.md Add split keyboard example for Bootmagic Lite (#16349) 3 years ago
feature_caps_word.md [Docs] Clarify CAPS_WORD behaviors (#18137) 3 years ago
feature_combo.md [Docs] Use layer number as example for COMBO_ONLY_FROM_LAYER (#18072) 3 years ago
feature_command.md Remove Full Bootmagic (#13846) 4 years ago
feature_converters.md Add Bonsai C4 converter (#17711) 3 years ago
feature_debounce_type.md Add sym_defer_pr debouncer type (#14948) 3 years ago
feature_digitizer.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_dip_switch.md Added right vs left specific pin assignments for dip switch (#13074) 4 years ago
feature_dynamic_macros.md Added Wait time to sending each Keys for Dynamic Macros function (#16800) 3 years ago
feature_eeprom.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 years ago
feature_encoders.md Discourage use of ENCODER_MAP at keyboard level (#18286) 3 years ago
feature_grave_esc.md Rename some Quantum keycodes (#15968) 3 years ago
feature_haptic_feedback.md [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 3 years ago
feature_hd44780.md HD44780 driver rework (#16370) 3 years ago
feature_joystick.md Joystick feature updates (#16732) 3 years ago
feature_key_lock.md Added cancel_key_lock function (#15321) 4 years ago
feature_key_overrides.md Basic keycode overhaul (#14726) 4 years ago
feature_layers.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 3 years ago
feature_layouts.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_leader_key.md [Docs] Update feature_leader_key.md (#16344) 3 years ago
feature_led_indicators.md Refine LED indicator documentation (#16304) 3 years ago
feature_led_matrix.md [Docs] Align LED Matrix docs with RGB matrix docs (#17140) 3 years ago
feature_macros.md docs: some typos (#18582) 3 years ago
feature_midi.md Update feature_midi.md (#17390) 3 years ago
feature_mouse_keys.md [Core] Mouse key kinetic mode fix (#17176) 3 years ago
feature_oled_driver.md docs: some typos (#18582) 3 years ago
feature_pointing_device.md Create generic Pointing Device Pin defines (#17776) 3 years ago
feature_programmable_button.md Add Support for USB programmable buttons (#12950) 4 years ago
feature_ps2_mouse.md Align PS/2 GPIO defines (#14745) 4 years ago
feature_rawhid.md [Docs] Clean up some code block languages (#14434) 4 years ago
feature_rgb_matrix.md docs: some typos (#18582) 3 years ago
feature_rgblight.md Add deprecated check for RGBLIGHT_ANIMATIONS (#17832) 3 years ago
feature_secure.md Add basic secure docs (#17577) 3 years ago
feature_send_string.md Feature-ify Send String (#17275) 3 years ago
feature_sequencer.md
…
feature_space_cadet.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
feature_split_keyboard.md Update feature_split_keyboard.md to add extra detail about left and right matrices. (#17492) 3 years ago
feature_st7565.md ST7565 invert (#13237) 4 years ago
feature_stenography.md Rename postprocess_steno_user → post_process_steno_user (#17823) 3 years ago
feature_swap_hands.md Add support for encoder mapping. (#13286) 3 years ago
feature_tap_dance.md Update feature_tap_dance.md (#18509) 3 years ago
feature_thermal_printer.md
…
feature_unicode.md Added emacs as an "operating system" for input mode. (#16949) 3 years ago
feature_userspace.md Enable CLI flashing via mdloader (#14729) 4 years ago
feature_velocikey.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
feature_wpm.md Fixes potential wpm sampling overflow, along with code comment fixes (#15277) 3 years ago
flash_driver.md Added external spi flash driver. (#15419) 3 years ago
flashing.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
flashing_bootloadhid.md [Docs] RESET -> QK_BOOT (#18365) 3 years ago
fuse.txt
…
getting_started_docker.md [Docs] Clean up some code block languages (#14434) 4 years ago
getting_started_github.md Purge uGFX. (#14720) 4 years ago
getting_started_introduction.md
…
getting_started_make_guide.md Add support for deferred executors. (#14859) 4 years ago
getting_started_vagrant.md [Docs] Clean up some code block languages (#14434) 4 years ago
gpio_control.md Move Doxygen docs to subdirectory (#16561) 3 years ago
hand_wire.md Improve importer workflow (#17707) 3 years ago
hardware_drivers.md Purge uGFX. (#14720) 4 years ago
hardware_keyboard_guidelines.md add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247) 3 years ago
how_a_matrix_works.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
how_keyboards_work.md docs: reflect systemd's change in language (#17322) 3 years ago
i2c_driver.md Fix i2c driver doc: Incorrect name (#16898) 3 years ago
index.html Fix anchors with <code> in table of content (#15169) 3 years ago
isp_flashing_guide.md ISP flashing guide: add instructions for flashing STM32duino bootloader (#16568) 3 years ago
keycodes.md Add ability to enter bootloader mode from `QK_MAKE` (#17745) 3 years ago
keycodes_basic.md Basic keycode overhaul (#14726) 4 years ago
keycodes_magic.md PoC: Swap Escape and Caps (#16336) 3 years ago
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
keymap.md Remove orphan custom functions reference in keymap docs (#18444) 3 years ago
mod_tap.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
newbs_building_firmware.md Fix typo (#18526) 3 years ago
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly (#11518) 4 years ago
newbs_building_firmware_workflow.md [Docs] Building with GitHub Userspace (#16271) 3 years ago
newbs_flashing.md Add note about qmk doctor in newbs_flashing.md (#15688) 3 years ago
newbs_getting_started.md Attempt to discourage manual MSYS install for new users (#17556) 3 years ago
newbs_git_best_practices.md
…
newbs_git_resolving_merge_conflicts.md
…
newbs_git_resynchronize_a_branch.md [Docs] Clean up some code block languages (#14434) 4 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 Small tweaks to docs to make them more user friendly (#11518) 4 years ago
one_shot_keys.md fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 4 years ago
other_eclipse.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
other_vscode.md Update other_vscode.md (#17317) 3 years ago
platformdev_blackpill_f4x1.md [Docs] Update platformdev_blackpill_f411.md (#18666) 3 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 [Docs] Clarify how to use the bootloader LED for rp2040 (#18585) 3 years ago
platformdev_selecting_arm_mcu.md
…
porting_your_keyboard_to_qmk.md Align new-keyboard with recent schema updates (#16378) 3 years ago
power.txt
…
pr_checklist.md Grammar Fix for PR Checklist (#18540) 3 years ago
qmk.css
…
qmk_custom_dark.css Small tweaks to docs to make them more user friendly (#11518) 4 years ago
qmk_custom_light.css Small tweaks to docs to make them more user friendly (#11518) 4 years ago
quantum_keycodes.md Add ability to enter bootloader mode from `QK_MAKE` (#17745) 3 years ago
quantum_painter.md Add ST7735 driver to Quantum Painter (#17848) 3 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 Update ref_functions.md (replaced deprecated `RESET`) (#17436) 3 years ago
reference_configurator_support.md Basic keycode overhaul (#14726) 4 years ago
reference_glossary.md Fix Space Cadet md link (#14300) 4 years ago
reference_info_json.md [docs] Improve documentation regarding info.json (#18508) 3 years ago
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 3 years ago
serial_driver.md spelling fix (#18831) 3 years ago
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 4 years ago
squeezing_avr.md [Docs] Update list of "ARM-based ProMicro replacements" (#18083) 3 years ago
support.md
…
sw.js
…
syllabus.md [Docs] Squeezing space out of AVR (#15243) 4 years ago
tap_hold.md docs: fix typos (#18671) 3 years ago
translating.md
…
uart_driver.md Update UART driver API (#14839) 4 years ago
understanding_qmk.md [Docs] Update 'Process Record' according to the code (#18209) 3 years ago
unit_testing.md Remove SERIAL_LINK feature (#14727) 4 years ago
usb_nkro.txt
…
ws2812_driver.md [Core] Add Raspberry Pi RP2040 support (#14877) 3 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.