History

Albert Y a63c2c5f50 Add example for turning off RGB colors and retaining indicator function (#14997 ) * Add init function for solid effect with colors off * Restructure sentence Co-authored-by: filterpaper <filterpaper@localhost>		2021-11-05 19:11:45 +11:00
..
ChangeLog	…
de	…
es	…
fr-fr	…
gitbook/images	…
he-il	…
ja	add docs/ja/ja_doc_status.sh (#14402 )	2021-10-16 17:31:09 +09:00
ko-kr	…
pt-br	…
ru-ru	…
zh-cn	[Docs] update suspend_*_user examples (#14542 )	2021-09-21 16:40:19 -07:00
.nojekyll	…
CNAME	…
README.md	…
_langs.md	…
_summary.md	…
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
api_docs.md	…
api_overview.md	…
arm_debugging.md	…
audio_driver.md	…
breaking_changes.md	…
breaking_changes_history.md	…
breaking_changes_instructions.md	…
chibios_upgrade_instructions.md	…
cli.md	…
cli_commands.md	CLI: Add 'cd' subcommand (#12584 )	2021-11-05 08:21:09 +11:00
cli_configuration.md	…
cli_development.md	…
cli_tab_complete.md	Fix Typo in documentation (#14942 )	2021-10-24 23:32:42 +01:00
coding_conventions_c.md	…
coding_conventions_python.md	Refactor new-keyboard to be python3.7 compatible (#14707 )	2021-11-05 08:14:43 +11:00
compatible_microcontrollers.md	…
config_options.md	Document `MAGIC` feature (#14301 )	2021-10-26 16:55:04 -07:00
configurator_architecture.md	…
configurator_default_keymaps.md	…
configurator_diagram.drawio	…
configurator_diagram.svg	…
configurator_step_by_step.md	…
configurator_troubleshooting.md	…
contributing.md	…
custom_matrix.md	…
custom_quantum_functions.md	[Docs] update suspend_*_user examples (#14542 )	2021-09-21 16:40:19 -07:00
data_driven_config.md	…
documentation_best_practices.md	…
documentation_templates.md	…
driver_installation_zadig.md	…
easy_maker.md	…
eeprom_driver.md	…
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
faq_misc.md	…
feature_advanced_keycodes.md	…
feature_audio.md	…
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_combo.md	…
feature_command.md	…
feature_debounce_type.md	…
feature_digitizer.md	…
feature_dip_switch.md	…
feature_dynamic_macros.md	…
feature_encoders.md	[Docs] Modify encoder_update_user example to return false (#14541 )	2021-09-21 07:52:57 -07:00
feature_grave_esc.md	…
feature_haptic_feedback.md	Fix documentation for NO_HAPTIC_MOD and NO_HAPTIC_FN features. (#14180 )	2021-10-01 07:24:19 +10:00
feature_hd44780.md	…
feature_joystick.md	…
feature_key_lock.md	…
feature_key_overrides.md	…
feature_layers.md	…
feature_layouts.md	…
feature_leader_key.md	…
feature_led_indicators.md	[Docs] add sync options heading, update led indicators (#14441 )	2021-09-15 10:11:25 -07:00
feature_led_matrix.md	[Docs] fix wrong directory for RGB Matrix animations (#14494 )	2021-09-19 11:53:22 -07:00
feature_macros.md	…
feature_midi.md	…
feature_mouse_keys.md	…
feature_oled_driver.md	Clarify placement of configuration options (#15015 )	2021-11-02 17:19:01 +11:00
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rawhid.md	…
feature_rgb_matrix.md	Add example for turning off RGB colors and retaining indicator function (#14997 )	2021-11-05 19:11:45 +11:00
feature_rgblight.md	…
feature_sequencer.md	…
feature_space_cadet.md	…
feature_split_keyboard.md	[Docs] add sync options heading, update led indicators (#14441 )	2021-09-15 10:11:25 -07:00
feature_st7565.md	…
feature_stenography.md	[DOCS] Fix the STENO_COMBINEDMAP table (#14883 )	2021-10-20 01:26:59 +11:00
feature_swap_hands.md	…
feature_tap_dance.md	[Docs] Add default case to tap dance example 5. (#14893 )	2021-10-22 23:45:07 -07:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
feature_velocikey.md	…
feature_wpm.md	…
flashing.md	…
flashing_bootloadhid.md	…
fuse.txt	…
getting_started_docker.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
hand_wire.md	…
hardware_avr.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	…
how_a_matrix_works.md	…
how_keyboards_work.md	…
i2c_driver.md	…
index.html	…
internals_defines.md	…
internals_gpio_control.md	Update documentation because GPIO functions are no longer in quantum.h (#14826 )	2021-10-16 01:43:03 +01:00
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	Rework ISP flashing guide (#14938 )	2021-11-05 14:42:08 +11:00
keycodes.md	Add MAGIC_TOGGLE_GUI line to main keycode documentation (#14959 )	2021-10-27 01:09:12 +01:00
keycodes_basic.md	…
keycodes_magic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
mod_tap.md	Document examples on intercepting Mod-Tap (#14502 )	2021-10-04 16:21:02 -07:00
newbs.md	…
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	…
newbs_flashing.md	…
newbs_getting_started.md	[Docs] Add instructions to create keymap before proceeding (#14945 )	2021-10-27 08:03:00 -07:00
newbs_git_best_practices.md	…
newbs_git_resolving_merge_conflicts.md	…
newbs_git_resynchronize_a_branch.md	…
newbs_git_using_your_master_branch.md	…
newbs_learn_more_resources.md	…
newbs_testing_debugging.md	…
one_shot_keys.md	…
other_eclipse.md	…
other_vscode.md	…
platformdev_chibios_earlyinit.md	…
platformdev_selecting_arm_mcu.md	…
power.txt	…
pr_checklist.md	More PR checklist updates (#14705 )	2021-10-06 06:46:36 +11:00
proton_c_conversion.md	…
qmk.css	…
qmk_custom_dark.css	…
qmk_custom_light.css	…
quantum_keycodes.md	…
redirects.json	…
ref_functions.md	…
reference_configurator_support.md	…
reference_glossary.md	…
reference_info_json.md	[Docs] Clean up reference_info_json.md (#14806 )	2021-10-15 12:45:33 +11:00
reference_keymap_extras.md	…
serial_driver.md	…
spi_driver.md	…
support.md	…
sw.js	…
syllabus.md	…
tap_hold.md	…
translating.md	…
uart_driver.md	…
understanding_qmk.md	[Docs] Broken FAQ hyperlink (#14578 )	2021-09-24 08:43:05 -07:00
unit_testing.md	…
usb_nkro.txt	…
ws2812_driver.md	…

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