My local repo of qmk firmware.

History

Joel Challis 0d9a0d5d97 Align new-keyboard with recent schema updates (#16378 )		3 years ago
..
ChangeLog	[Core] Split support for pointing devices. (#15304 )	3 years ago
gitbook/images	…
ja	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	3 years ago
zh-cn	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	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	Align docs to new-keyboard behaviour (#16357 )	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	[Docs] Use HTTPS for images and links where possible (#11695 )	4 years ago
arm_debugging.md	…
audio_driver.md	[Docs] Clean up some code block languages (#14434 )	4 years ago
breaking_changes.md	Fix last merge date (#15327 )	4 years ago
breaking_changes_history.md	Changelog 2021q4 (#15325 )	4 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	Initial pass at data driven new-keyboard subcommand (#12795 )	3 years ago
cli_configuration.md	…
cli_development.md	[Docs] Clean up some code block languages (#14434 )	4 years ago
cli_tab_complete.md	Fix Typo in documentation (#14942 )	4 years ago
coding_conventions_c.md	[Docs] Use HTTPS for images and links where possible (#11695 )	4 years ago
coding_conventions_python.md	Refactor new-keyboard to be python3.7 compatible (#14707 )	4 years ago
compatible_microcontrollers.md	Add L432, L442. (#16016 )	3 years ago
config_options.md	Merge remote-tracking branch 'upstream/master' into develop	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	add 'info_config.h' into docs/hardware_keyboard_guidelines.md (#16247 )	3 years ago
documentation_best_practices.md	…
documentation_templates.md	[Docs] Use HTTPS for images and links where possible (#11695 )	4 years ago
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	[Docs] Use HTTPS for images and links where possible (#11695 )	4 years ago
faq_debug.md	doc/faq_debug: qmk cli can also be used to print debug messages (#15528 )	3 years ago
faq_general.md	Fix typos and reword some sentences in FAQs (#11546 )	4 years ago
faq_keymap.md	Basic keycode overhaul (#14726 )	4 years ago
faq_misc.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	4 years ago
feature_advanced_keycodes.md	Additional documentation for GUI mod combo (#13266 )	4 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	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	4 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	Fix typo in docs/feature_dynamic_macros (#10085 )	5 years ago
feature_encoders.md	Sentence structure update (#16306 )	3 years ago
feature_grave_esc.md	Rename some Quantum keycodes (#15968 )	3 years ago
feature_haptic_feedback.md	Rip out old macro and action_function system (#16025 )	3 years ago
feature_hd44780.md	…
feature_joystick.md	[Docs] Clean up some code block languages (#14434 )	4 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	2021 May 29 Breaking Changes Update (#13034 )	4 years ago
feature_led_indicators.md	Improve description of LED state data sync option (#16302 )	3 years ago
feature_led_matrix.md	Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989 )	3 years ago
feature_macros.md	[Docs] feature_macro.md: minor formatting fix (#16205 )	3 years ago
feature_midi.md	[Docs] Clean up some code block languages (#14434 )	4 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	Remove default pointing device driver. (#16190 )	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	Add RGB matrix & LED Matrix support for IS31FL3742A, IS31FL3743A, IS31FL3745, IS31FL3746A (#14989 )	3 years ago
feature_rgblight.md	[Docs] RGB documentation formatting corrections (#15826 )	3 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	Merge remote-tracking branch 'origin/master' into develop	3 years ago
feature_st7565.md	ST7565 invert (#13237 )	4 years ago
feature_stenography.md	Merge remote-tracking branch 'origin/master' into develop	4 years ago
feature_swap_hands.md	Document swap-hands tap-toggle feature (#15229 )	4 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	2021 May 29 Breaking Changes Update (#13034 )	4 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 RESET not working for keyboards with Kiibohd bootloader (#15430 )	3 years ago
flashing_bootloadhid.md	[Docs] Clean up some code block languages (#14434 )	4 years ago
fuse.txt	Ensure single newline at EOF for core files (#11310 )	4 years ago
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
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	[Docs] Use HTTPS for images and links where possible (#11695 )	4 years ago
how_keyboards_work.md	[Docs] Clean up some code block languages (#14434 )	4 years ago
i2c_driver.md	i2c_master: Add support for reading/writing to 16-bit registers (#14289 )	4 years ago
index.html	Align docs to new-keyboard behaviour (#16357 )	3 years ago
internals_defines.md	…
internals_gpio_control.md	Add open-drain GPIO support. (#15282 )	3 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	Add a warning about USBtinyISP limitations to the ISP flashing guide (#15898 )	3 years ago
keycodes.md	Rename some Quantum keycodes (#15968 )	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	Rip out old macro and action_function system (#16025 )	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	[Docs] Move QMK newbs build environment guide to next section (#15386 )	3 years ago
newbs_building_firmware_configurator.md	Small tweaks to docs to make them more user friendly (#11518 )	4 years ago
newbs_flashing.md	[Docs] newbs_flashing.md: add link to build environment section (#15654 )	3 years ago
newbs_getting_started.md	[Docs] Move QMK newbs build environment guide to next section (#15386 )	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	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	[Docs] Address some typos (also in moonlander matrix.c) (#16248 )	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	[Docs] pr checklist: update doc hyperlinks to relative ones and use IDs (#16263 )	3 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	Rename some Quantum keycodes (#15968 )	3 years ago
redirects.json	…
ref_functions.md	fix typo (#15569 )	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	CLI: Parse USB device version BCD (#14580 )	3 years ago
reference_keymap_extras.md	Rework keymap_extras docs (#13949 )	4 years ago
serial_driver.md	Make solo half of split keyboards (more) usable. (#13523 )	4 years ago
spi_driver.md	Merge remote-tracking branch 'upstream/master' into develop	4 years ago
squeezing_avr.md	[Core] Add Pixel Flow RGB matrix effect (#15829 )	3 years ago
support.md	…
sw.js	…
syllabus.md	[Docs] Squeezing space out of AVR (#15243 )	4 years ago
tap_hold.md	New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036 )	4 years ago
translating.md	…
uart_driver.md	Update UART driver API (#14839 )	4 years ago
understanding_qmk.md	[Docs] Reorder functions in Understanding QMK (#15357 )	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.

Help people out on our forums and chat rooms:
- /r/olkb
- Discord Server
Contribute to our documentation by clicking "Edit This Page" at the bottom
Translate our documentation into your language
Report a bug
Open a Pull Request