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.
21025 Commits
54 Branches
1475 Tags
301 MiB
 
 
 
 
Tag: Branch: Tree: 026d0e8bf1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '026d0e8bf1'
${ noResults }
qmk_firmware/docs
History
Tom Barnes 026d0e8bf1
Update feature_midi.md (#17390) 		3 years ago
..
ChangeLog Breaking changes for 2022q2. (#17221) 3 years ago
gitbook/images
…
internals Move Doxygen docs to subdirectory (#16561) 3 years ago
ja Merge remote-tracking branch 'origin/master' into develop 3 years ago
zh-cn Fix docs typo (#17254) 3 years ago
.nojekyll
…
CNAME
…
README.md
…
_langs.md Remove stale docs translations (#15737) 3 years ago
_summary.md stub changelog 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] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
api_overview.md
…
arm_debugging.md
…
audio_driver.md [Docs] Clean up some code block languages (#14434) 4 years ago
breaking_changes.md Fixup command sequencing for master/develop. (#17227) 3 years ago
breaking_changes_history.md stub changelog 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 Quantum Painter (#10174) 3 years ago
cli_configuration.md
…
cli_development.md Some docs improvements (#15845) 3 years ago
cli_tab_complete.md Fix Typo in documentation (#14942) 4 years ago
coding_conventions_c.md
…
coding_conventions_python.md Refactor new-keyboard to be python3.7 compatible (#14707) 4 years ago
compatible_microcontrollers.md Added support for Wb32fq95 (#16871) 3 years ago
config_options.md [Core] Add compile/make macro to core (#15959) 3 years ago
configurator_architecture.md Architecture documentation for Configurator and API (#13935) 4 years ago
configurator_default_keymaps.md Basic keycode overhaul (#14726) 4 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 [Docs] Clean up some code block languages (#14434) 4 years ago
custom_quantum_functions.md Point out that deferred execution needs to be enabled in rules.mk (#16196) 3 years ago
data_driven_config.md Change data driven "str" type to represent a quoted string literal (#16516) 3 years ago
documentation_best_practices.md
…
documentation_templates.md
…
driver_installation_zadig.md [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 years ago
easy_maker.md update the Chinese translation based on the latest English version (#14924) 3 years ago
eeprom_driver.md eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 4 years ago
faq_build.md
…
faq_debug.md doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 3 years ago
faq_general.md
…
faq_keymap.md Keymap FAQ updates (#17130) 3 years ago
faq_misc.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
feature_advanced_keycodes.md Add trailing parens to `get_oneshot_mods` in feature_advanced_keycodes.md (#17211) 3 years ago
feature_audio.md Fixup Audio startup and add to documents (#13606) 4 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 [Core] Add Caps Word feature to core (#16588) 3 years ago
feature_combo.md New combo configuration options (#15083) 3 years ago
feature_command.md Remove Full Bootmagic (#13846) 4 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
…
feature_encoders.md Breaking changes for 2022q2. (#17221) 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 Move tmk_core/common/<plat> (#13918) 4 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] feature_macro.md: minor formatting fix (#16205) 3 years ago
feature_midi.md Update feature_midi.md (#17390) 3 years ago
feature_mouse_keys.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_oled_driver.md [Docs] OLED documentation edits (#15977) 3 years ago
feature_pointing_device.md Add support for multiple sensors to pmw3360 (#15996) 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 Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_rgblight.md rgblight: Add functions to stop blinking one or all but one layer (#16859) 3 years ago
feature_sequencer.md
…
feature_space_cadet.md
…
feature_split_keyboard.md Merge remote-tracking branch 'origin/master' into develop 3 years ago
feature_st7565.md ST7565 invert (#13237) 4 years ago
feature_stenography.md [Docs] Update Steno Keycode Table (#17155) 3 years ago
feature_swap_hands.md Add support for encoder mapping. (#13286) 3 years ago
feature_tap_dance.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
feature_terminal.md
…
feature_thermal_printer.md
…
feature_unicode.md Remove `send_unicode_hex_string()` (#16518) 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 Fix docs typo (#17254) 3 years ago
flashing_bootloadhid.md [Docs] Clean up some code block languages (#14434) 4 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 [Docs] Added information on soldering diodes in parallel (#13117) 4 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
…
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 [Core] Add Caps Word feature to core (#16588) 3 years ago
keycodes_basic.md Basic keycode overhaul (#14726) 4 years ago
keycodes_magic.md Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (#15368) 3 years ago
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
keymap.md Some docs improvements (#15845) 3 years ago
mod_tap.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 3 years ago
newbs.md
…
newbs_building_firmware.md [Docs] Update newbs_building_firmware.md (#16333) 3 years ago
newbs_building_firmware_configurator.md
…
newbs_flashing.md [Docs] newbs_flashing.md: add link to build environment section (#15654) 3 years ago
newbs_getting_started.md Recommend pillow as part of manual MSYS install (#17133) 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 Add Atom editor suggestion (#15969) 3 years ago
newbs_testing_debugging.md
…
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_chibios_earlyinit.md Fixes for bootloader refactor build failures (#15638) 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 Update pr_checklist.md (#17122) 3 years ago
proton_c_conversion.md Move Doxygen docs to subdirectory (#16561) 3 years ago
qmk.css
…
qmk_custom_dark.css
…
qmk_custom_light.css
…
quantum_keycodes.md [Core] Add Reboot keycode to core (#15990) 3 years ago
quantum_painter.md Quantum Painter (#10174) 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 Fix typo in docs/ref_functions.md (#16690) 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 Fix in-page links in reference_info_json.md (#16487) 3 years ago
reference_keymap_extras.md Rename keymap_extras headers for consistency (#16939) 3 years ago
serial_driver.md Make solo half of split keyboards (more) usable. (#13523) 4 years ago
spi_driver.md
…
squeezing_avr.md [Core] Allow usage of AVRs minimal printf library (#16266) 3 years ago
support.md
…
sw.js
…
syllabus.md [Docs] Squeezing space out of AVR (#15243) 4 years ago
tap_hold.md Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 3 years ago
translating.md
…
uart_driver.md Update UART driver API (#14839) 4 years ago
understanding_qmk.md Some docs improvements (#15845) 3 years ago
unit_testing.md Remove SERIAL_LINK feature (#14727) 4 years ago
usb_nkro.txt
…
ws2812_driver.md Documentation typo fix (#15298) 4 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.