poz/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
qmk_firmware/docs
History
Zach White b705020daf
move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230)
2021-08-29 16:41:56 -07:00
..
ChangeLog Bootmagic lite docs clarity. (#14204) 2021-08-29 09:47:48 +10:00
de Merge remote-tracking branch 'origin/master' into develop 2021-08-20 22:32:01 +00:00
es Merge remote-tracking branch 'origin/master' into develop 2021-08-20 22:32:01 +00:00
fr-fr Merge remote-tracking branch 'origin/master' into develop 2021-08-20 22:32:01 +00:00
gitbook/images
he-il [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
ja move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
ko-kr [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
pt-br [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
ru-ru [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
zh-cn Merge remote-tracking branch 'origin/master' into develop 2021-08-20 22:32:01 +00:00
.nojekyll
_langs.md
_summary.md Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 2021-08-18 04:52:44 +10:00
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 2021Q3 pre-merge develop changelog, keyboard aliases (#14198) 2021-08-29 08:18:18 +10:00
breaking_changes_history.md 2021Q3 pre-merge develop changelog, keyboard aliases (#14198) 2021-08-29 08:18:18 +10:00
breaking_changes_instructions.md
chibios_upgrade_instructions.md
cli.md
cli_commands.md --parallel improvements (#13800) 2021-08-18 08:46:59 +10:00
cli_configuration.md
cli_development.md CLI/Docs: Fix the format commands' name (#13668) 2021-07-23 21:41:33 +01:00
cli_tab_complete.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md Add support for STM32F407x MCUs. (#13718) 2021-08-09 06:52:13 +10:00
config_options.md Enable sync of OLED/ST7565 display on/off state on Splits (#13542) 2021-08-15 15:39:08 +10:00
configurator_architecture.md Architecture documentation for Configurator and API (#13935) 2021-08-10 07:47:53 -07:00
configurator_default_keymaps.md
configurator_diagram.drawio Architecture documentation for Configurator and API (#13935) 2021-08-10 07:47:53 -07:00
configurator_diagram.svg Architecture documentation for Configurator and API (#13935) 2021-08-10 07:47:53 -07:00
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
custom_matrix.md
custom_quantum_functions.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
data_driven_config.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
easy_maker.md [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 2021-08-14 08:42:59 -07:00
eeprom_driver.md
faq_build.md
faq_debug.md Allow output of logging when running unit tests (#13556) 2021-07-25 17:18:09 +01:00
faq_general.md
faq_keymap.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md Fixup Audio startup and add to documents (#13606) 2021-08-15 21:51:50 +01:00
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
feature_combo.md Process combos earlier & overlapping combos (#8591) 2021-08-06 09:44:57 +10:00
feature_command.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
feature_debounce_type.md Remove backwards compatibility of debounce names (#13877) 2021-08-09 19:46:18 +01:00
feature_digitizer.md Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 2021-08-18 04:52:44 +10:00
feature_dip_switch.md Added right vs left specific pin assignments for dip switch (#13074) 2021-08-19 18:39:15 +01:00
feature_dynamic_macros.md
feature_encoders.md Allow for removal of hysteresis on 4x encoders (#13698) 2021-08-18 09:40:00 +10:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md
feature_key_lock.md
feature_key_overrides.md [Feature] Key Overrides (#11422) 2021-07-13 10:13:51 -07:00
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md [Docs] Added note about no split support (#12512) 2021-07-20 10:11:49 -07:00
feature_led_matrix.md Rgb matrix/enable modes explicitly (#13758) 2021-08-18 04:19:00 +10:00
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md [Core] Refactor OLED to allow easy addition of other types (#13454) 2021-08-24 16:28:26 +10:00
feature_pointing_device.md
feature_ps2_mouse.md [Feature] Swap buttons on PS2 Mouse/Trackball (#9205) 2021-08-06 09:09:58 +10:00
feature_rawhid.md
feature_rgb_matrix.md [Docs] Add examples to RGB Matrix Indicators docs (#12797) 2021-08-27 06:41:33 +10:00
feature_rgblight.md Retain brightness with lighting layers (#13025) 2021-07-21 23:46:12 -07:00
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Make solo half of split keyboards (more) usable. (#13523) 2021-08-22 10:51:17 +10:00
feature_st7565.md
feature_stenography.md Steno combinedkeys (#12538) 2021-08-18 04:48:00 +10:00
feature_swap_hands.md
feature_tap_dance.md matrix_scan_x -> x_task (#13748) 2021-07-28 12:01:23 +01:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md Update feature_wpm.md (#13936) 2021-08-10 10:14:14 +01:00
flashing.md adding uf2 flash support for blackpill 401 (#13968) 2021-08-24 08:05:10 +10:00
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 move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
hand_wire.md [Docs] Added information on soldering diodes in parallel (#13117) 2021-07-29 22:56:27 -07:00
hardware_avr.md Port new_keyboard.sh to CLI (#13706) 2021-07-30 21:57:40 +01:00
hardware_drivers.md
hardware_keyboard_guidelines.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
internals_defines.md
internals_gpio_control.md
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
keycodes.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
keycodes_basic.md
keycodes_magic.md Add a toggle key for GUI On/Off in Magic feature (#13830) 2021-08-18 08:47:50 +10:00
keycodes_us_ansi_shifted.md
keymap.md
mod_tap.md
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_flashing.md
newbs_getting_started.md
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 fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 2021-07-28 12:00:55 +01:00
other_eclipse.md
other_vscode.md [Core] [Docs] Remove travis-ci references (#13916) 2021-08-20 23:31:26 +01:00
platformdev_chibios_earlyinit.md
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md Explicitly state that VIA should not be enabled in the default keymap. (#13803) 2021-07-31 09:21:45 +10:00
proton_c_conversion.md
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
README.md
redirects.json
ref_functions.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
reference_configurator_support.md Remove references to info.json width and height in CLI (#13728) 2021-07-29 22:37:18 -07:00
reference_glossary.md
reference_info_json.md Remove references to info.json width and height in CLI (#13728) 2021-07-29 22:37:18 -07:00
reference_keymap_extras.md Rework keymap_extras docs (#13949) 2021-08-15 00:18:20 +10:00
serial_driver.md Make solo half of split keyboards (more) usable. (#13523) 2021-08-22 10:51:17 +10:00
spi_driver.md
support.md
sw.js
syllabus.md Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
tap_hold.md Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) 2021-08-07 09:16:26 +10:00
translating.md
uart_driver.md
understanding_qmk.md [Feature] Key Overrides (#11422) 2021-07-13 10:13:51 -07:00
unit_testing.md Allow output of logging when running unit tests (#13556) 2021-07-25 17:18:09 +01:00
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.