qmk_firmware/docs
Joel Challis 4e8166750b
Small tweaks to docs to make them more user friendly ()
* first pass

* firmware firmware?

* Split out debug + testing docs

* tidy up duplicate css

* Add extra info to debug example

Co-authored-by: Drashna Jaelre <drashna@live.com>

Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-01-20 18:46:01 +00:00
..
ChangeLog Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
de
es Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
fr-fr
gitbook/images
he-il Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
ja [Docs] Japanese translation of feature_rawhid.md () 2021-01-06 14:08:21 +09:00
ko-kr
pt-br
ru-ru
zh-cn
.nojekyll
CNAME
README.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
_langs.md
_summary.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
breaking_changes.md
breaking_changes_instructions.md
cli.md
cli_commands.md Improve the compile and flash subcommands () 2021-01-16 15:13:04 -08:00
cli_configuration.md
cli_development.md
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md
configurator_default_keymaps.md
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md Zadig docs: add APM32 device name () 2020-12-30 16:35:06 +00:00
eeprom_driver.md
faq_build.md
faq_debug.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
faq_general.md
faq_keymap.md
faq_misc.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
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 Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
feature_dip_switch.md
feature_dynamic_macros.md
feature_encoders.md
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md
feature_key_lock.md
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md
feature_led_matrix.md
feature_macros.md Typo fix: Useful function -> Useful Functions () 2020-12-30 01:32:30 +09:00
feature_mouse_keys.md
feature_oled_driver.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md allow customizing decrease delay of rgb heatmap () 2021-01-14 11:29:00 -08:00
feature_rgblight.md Improve the Lighting Layers example in RGB Lighting docs () 2021-01-19 18:49:02 -08:00
feature_sequencer.md Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
feature_space_cadet.md
feature_split_keyboard.md
feature_stenography.md Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md Fix documentation so UCIS example compiles. () 2021-01-14 11:11:59 +11:00
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flashing.md Add stm32-dfu and apm32-dfu to bootloader.mk () 2021-01-20 14:04:21 +11:00
flashing_bootloadhid.md
fuse.txt Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
hand_wire.md [Docs] Fix typo in hand_wire.md () 2021-01-01 17:36:17 -08:00
hardware_avr.md Fix documentation of `lsusb` behaviour () 2021-01-10 21:48:29 -08:00
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
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 Update keycode docs () 2020-12-30 07:51:36 +11:00
keycodes_basic.md Update keycode docs () 2020-12-30 07:51:36 +11:00
keycodes_us_ansi_shifted.md
keymap.md
mod_tap.md
newbs.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
newbs_building_firmware.md
newbs_building_firmware_configurator.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
newbs_flashing.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
newbs_getting_started.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00: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 Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
newbs_testing_debugging.md Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
one_shot_keys.md
other_eclipse.md
other_vscode.md
platformdev_chibios_earlyinit.md Ensure single newline at EOF for core files () 2020-12-28 04:36:32 +11:00
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md
proton_c_conversion.md
qmk.css
qmk_custom_dark.css Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
qmk_custom_light.css Small tweaks to docs to make them more user friendly () 2021-01-20 18:46:01 +00:00
quantum_keycodes.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md
reference_keymap_extras.md Added mac variant of portuguese keymap extras () 2020-12-29 19:40:58 -08:00
serial_driver.md
spi_driver.md
support.md
sw.js
syllabus.md
tap_hold.md
translating.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt
ws2812_driver.md Add BGR byte order for WS2812 drivers () 2021-01-16 08:42:30 +11:00

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.