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.
16906 Commits
54 Branches
1475 Tags
301 MiB
 
 
 
 
Tag: Branch: Tree: fdcea06336
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fdcea06336'
${ noResults }
qmk_firmware/docs
History
Erovia fdcea06336
CLI/Docs: Fix the format commands' name (#13668) 		4 years ago
..
ChangeLog 2021 May 29 Breaking Changes Update (#13034) 4 years ago
de CLI/Docs: Fix the format commands' name (#13668) 4 years ago
es [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
fr-fr CLI/Docs: Fix the format commands' name (#13668) 4 years ago
gitbook/images
…
he-il [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
ja CLI/Docs: Fix the format commands' name (#13668) 4 years ago
ko-kr [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
pt-br [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
ru-ru [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
zh-cn [Bug] Develop - Change uint32_t to layer_state_t (#13596) 4 years ago
.nojekyll
…
CNAME
…
README.md Small tweaks to docs to make them more user friendly (#11518) 4 years ago
_langs.md
…
_summary.md [Feature] Key Overrides (#11422) 4 years ago
adc_driver.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
api_development_environment.md Add API documentation 5 years ago
api_development_overview.md Add API documentation 5 years ago
api_docs.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
api_overview.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
arm_debugging.md
…
audio_driver.md Audio system overhaul (#11820) 4 years ago
breaking_changes.md Merge remote-tracking branch 'upstream/master' into develop 4 years ago
breaking_changes_history.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 5 years ago
chibios_upgrade_instructions.md Update ChibiOS, ChibiOS-Contrib. (#13056) 4 years ago
cli.md Streamline the macos install process 5 years ago
cli_commands.md CLI/Docs: Fix the format commands' name (#13668) 4 years ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 5 years ago
cli_development.md CLI/Docs: Fix the format commands' name (#13668) 4 years ago
cli_tab_complete.md Add support for tab completion (#12411) 4 years ago
coding_conventions_c.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
coding_conventions_python.md Move everything to Python 3.6 (#8835) 5 years ago
compatible_microcontrollers.md Adds support for STM32L412xB, STM32L422xB. (#13383) 4 years ago
config_options.md [Feature] Key Overrides (#11422) 4 years ago
configurator_default_keymaps.md [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 years ago
configurator_step_by_step.md Fix capitalisation of "GitHub" (#9184) 5 years ago
configurator_troubleshooting.md Polish Configurator section 5 years ago
contributing.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
custom_matrix.md
…
custom_quantum_functions.md Use single memcmp to determine if matrix changed. (#13064) 4 years ago
data_driven_config.md Create a system to map between info.json and config.h/rules.mk (#11548) 4 years ago
documentation_best_practices.md [Docs] fix file path (#9540) 5 years ago
documentation_templates.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
driver_installation_zadig.md Improve driver installation docs (#13562) 4 years ago
eeprom_driver.md eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 4 years ago
faq_build.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
faq_debug.md Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) 4 years ago
faq_general.md Fix typos and reword some sentences in FAQs (#11546) 4 years ago
faq_keymap.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
faq_misc.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
feature_advanced_keycodes.md Additional documentation for GUI mod combo (#13266) 4 years ago
feature_audio.md Document user song list file (#13101) 4 years ago
feature_auto_shift.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
feature_backlight.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
feature_bluetooth.md Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 years ago
feature_bootmagic.md Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 5 years ago
feature_combo.md changed type of process_combo_event argument in tutorial (#10621) 5 years ago
feature_command.md
…
feature_debounce_type.md Add asym_eager_defer_pk debounce type (#12689) 4 years ago
feature_dip_switch.md Convert Dip Switch callbacks to boolean functions (#13399) 4 years ago
feature_dynamic_macros.md Fix typo in docs/feature_dynamic_macros (#10085) 5 years ago
feature_encoders.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
feature_grave_esc.md
…
feature_haptic_feedback.md Add Per Key exclusions for Haptic Feedback (#12386) 4 years ago
feature_hd44780.md fixed typo for clear lcd screen function in hd44780 docs (#9086) 5 years ago
feature_joystick.md 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_key_lock.md Add explicit id tags to externally linked headers 5 years ago
feature_key_overrides.md [Feature] Key Overrides (#11422) 4 years ago
feature_layers.md Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 4 years ago
feature_layouts.md
…
feature_leader_key.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
feature_led_indicators.md [Docs] Added note about no split support (#12512) 4 years ago
feature_led_matrix.md Top level heading for common config (LED Matrix) (#13153) 4 years ago
feature_macros.md [Docs] New section to modifier docs: Checking Modifier State (#10550) 4 years ago
feature_midi.md [Docs] added basic midi documention of common features (#13113) 4 years ago
feature_mouse_keys.md Add support for 8 buttons to mouse report (#10807) 4 years ago
feature_oled_driver.md Add oled_invert (#13172) 4 years ago
feature_pointing_device.md Merge remote-tracking branch 'origin/master' into develop 4 years ago
feature_ps2_mouse.md fix(feature_ps2_mouse): fix Scroll Button example (#11669) 4 years ago
feature_rawhid.md Updated Raw HID docs to clarify packet/report length (#11211) 4 years ago
feature_rgb_matrix.md Dual RGB Matrix IS31FL3737 driver support to address #13442 (#13457) 4 years ago
feature_rgblight.md Retain brightness with lighting layers (#13025) 4 years ago
feature_sequencer.md Ensure single newline at EOF for core files (#11310) 4 years ago
feature_space_cadet.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
feature_split_keyboard.md Allow invert of SPLIT_HAND_PIN logic (#13433) 4 years ago
feature_st7565.md ST7565 invert (#13237) 4 years ago
feature_stenography.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
feature_swap_hands.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
feature_tap_dance.md More Tap Dance docs improvements (#12358) 4 years ago
feature_terminal.md
…
feature_thermal_printer.md
…
feature_unicode.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
feature_userspace.md Normalise include statements in core code (#11153) 4 years ago
feature_velocikey.md
…
feature_wpm.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
flashing.md 2021 May 29 Breaking Changes Update (#13034) 4 years ago
flashing_bootloadhid.md
…
fuse.txt Ensure single newline at EOF for core files (#11310) 4 years ago
getting_started_docker.md Add support for using podman to util/docker_build.sh (#10819) 4 years ago
getting_started_github.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
getting_started_introduction.md
…
getting_started_make_guide.md Documentation update (#12484) 4 years ago
getting_started_vagrant.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
hand_wire.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
hardware_avr.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
hardware_drivers.md
…
hardware_keyboard_guidelines.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
how_a_matrix_works.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
how_keyboards_work.md
…
i2c_driver.md Rework I2C driver docs (#11658) 4 years ago
index.html Simplify the visual flow of the getting started page (#11316) 4 years ago
internals_defines.md
…
internals_gpio_control.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
internals_input_callback_reg.md
…
internals_midi_device.md
…
internals_midi_device_setup_process.md
…
internals_midi_util.md
…
internals_send_functions.md
…
internals_sysex_tools.md
…
isp_flashing_guide.md [Docs] Update isp_flashing_guide.md (#11777) 4 years ago
keycodes.md [Docs] added list of MIDI keycodes (#13159) 4 years ago
keycodes_basic.md Update keycode docs (#11343) 4 years ago
keycodes_us_ansi_shifted.md
…
keymap.md [Docs] Clarify layer transparency keymap.md (#9081) 5 years ago
mod_tap.md Add Mac centric Shift and Alt + GUI Macros (#13107) 4 years ago
newbs.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
newbs_building_firmware.md Add explicit id tags to externally linked headers 5 years ago
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly (#11518) 4 years ago
newbs_flashing.md A few small typo fixes in docs (#12524) 4 years ago
newbs_getting_started.md Update FreeBSD install method (#12815) 4 years ago
newbs_git_best_practices.md
…
newbs_git_resolving_merge_conflicts.md
…
newbs_git_resynchronize_a_branch.md
…
newbs_git_using_your_master_branch.md Add explicit id tags to externally linked headers 5 years ago
newbs_learn_more_resources.md Small tweaks to docs to make them more user friendly (#11518) 4 years ago
newbs_testing_debugging.md Small tweaks to docs to make them more user friendly (#11518) 4 years ago
one_shot_keys.md [Docs] Update one_shot_keys.md (#12291) 4 years ago
other_eclipse.md eclipse: recommend changing the default project make target (#12447) 4 years ago
other_vscode.md Update other_vscode.md of Japanese document (#10604) 5 years ago
platformdev_chibios_earlyinit.md Ensure single newline at EOF for core files (#11310) 4 years ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 5 years ago
power.txt
…
pr_checklist.md [Docs] pr_checklist: fix capitalization of Vial (#13301) 4 years ago
proton_c_conversion.md Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 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 explicit id tags to externally linked headers 5 years ago
redirects.json
…
ref_functions.md [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 4 years ago
reference_configurator_support.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
reference_glossary.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
reference_info_json.md Merge remote-tracking branch 'origin/master' into develop 4 years ago
reference_keymap_extras.md Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 4 years ago
serial_driver.md [Core] Unite half-duplex and full-duplex serial drivers (#13081) 4 years ago
spi_driver.md Merge remote-tracking branch 'upstream/master' into develop 4 years ago
support.md Fix capitalisation of "GitHub" (#9184) 5 years ago
sw.js
…
syllabus.md [Feature] Key Overrides (#11422) 4 years ago
tap_hold.md Update IGNORE_MOD_TAP_INTERRUPT (#11452) 4 years ago
translating.md
…
uart_driver.md UART driver refactor (#11637) 4 years ago
understanding_qmk.md [Feature] Key Overrides (#11422) 4 years ago
unit_testing.md [Docs] Use HTTPS for images and links where possible (#11695) 4 years ago
usb_nkro.txt
…
ws2812_driver.md Fix up WS2812 SPI driver on F072. (#13022) 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.