1
0
Fork 0
forked from forks/qmk_firmware
qmk_firmware/docs
Nick Brassel 22be5190ab
Minor cleanup to breaking/checklist docs. ()
Co-authored-by: Ryan <fauxpark@gmail.com>
2023-01-19 22:30:16 +11:00
..
ChangeLog Minor cleanup to breaking/checklist docs. () 2023-01-19 22:30:16 +11:00
gitbook/images
internals
ja [Docs] Remove broken link () 2022-12-15 01:43:39 +11:00
zh-cn Macro keycode name refactoring () 2022-11-05 23:22:11 +11:00
.nojekyll
_langs.md Remove stale docs translations () 2022-01-04 18:11:24 -08:00
_summary.md Stub next develop dates 2022-11-22 01:27:15 +00:00
adc_driver.md 2021 May 29 Breaking Changes Update () 2021-05-29 14:38:50 -07:00
api_development_environment.md
api_development_overview.md
api_docs.md 2022 Nov 26 changelog. () 2022-11-28 07:33:55 +11:00
api_overview.md [Docs] Use HTTPS for images and links where possible () 2021-01-30 22:00:56 +11:00
arm_debugging.md
audio_driver.md
breaking_changes.md Minor cleanup to breaking/checklist docs. () 2023-01-19 22:30:16 +11:00
breaking_changes_history.md Stub next develop dates 2022-11-22 01:27:15 +00:00
breaking_changes_instructions.md
chibios_upgrade_instructions.md Add qmk mass-compile, which intends to supercede qmk multibuild whilst providing support for filtering as per data-driven definitions. () 2023-01-04 04:10:18 +00:00
cli.md
cli_commands.md docs: some typos () 2022-10-05 17:32:07 +01:00
cli_configuration.md
cli_development.md
cli_tab_complete.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md Merge remote-tracking branch 'origin/master' into develop 2022-11-15 18:41:13 +00:00
configurator_architecture.md
configurator_default_keymaps.md
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md Minor cleanup to breaking/checklist docs. () 2023-01-19 22:30:16 +11:00
custom_matrix.md Make debounce() signal changes in the cooked matrix as return value () 2022-07-07 10:00:40 +02:00
custom_quantum_functions.md [Docs] Extract 'Layer Change Code' and EEPROM () 2022-09-19 02:20:22 +01:00
data_driven_config.md Format DD mappings and schemas () 2022-11-08 01:05:08 +00:00
documentation_best_practices.md [Docs] fix file path () 2020-06-25 15:58:36 +10:00
documentation_templates.md [Docs] Touch up documentation templates & porting keyboard docs () 2023-01-13 02:58:38 -08:00
driver_installation_zadig.md
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md Remove legacy Debug keycode () 2022-10-19 11:33:05 +01:00
faq_general.md
faq_keymap.md Keymap FAQ updates () 2022-05-18 04:48:59 +10:00
faq_misc.md
feature_advanced_keycodes.md
feature_audio.md Align audio keycode names () 2022-11-05 17:05:19 +00:00
feature_auto_shift.md
feature_autocorrect.md
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_caps_word.md
feature_combo.md A comma was missing () 2023-01-05 15:12:46 +00:00
feature_command.md
feature_converters.md
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_eeprom.md
feature_encoders.md docs: add a note about reflashing both halves for encoder resolution () 2022-12-30 11:50:37 +11:00
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md
feature_joystick.md [Docs] Fix JOYSTICK_AXIS_COUNT name in docs () 2023-01-16 00:52:18 -08:00
feature_key_lock.md
feature_key_overrides.md
feature_layers.md Small doc changes () 2023-01-16 01:32:43 -08:00
feature_layouts.md
feature_leader_key.md Highlight inclusion of extern macro () 2023-01-18 00:26:16 +00:00
feature_led_indicators.md quantum: led: split out led_update_ports() for customization of led behaviour () 2022-10-06 21:24:41 +11:00
feature_led_matrix.md docs: Fix IS31FL3743A driver name () 2023-01-06 17:12:30 +00:00
feature_macros.md
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md Update OLED doc () 2022-11-30 17:48:23 +00:00
feature_pointing_device.md Fix references to mouse_report_t (which doesnt exist) () 2022-11-18 15:19:45 +00:00
feature_programmable_button.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md Use consistent highlight format () 2023-01-18 01:22:34 +00:00
feature_rgblight.md Fix description for selectively disabling animations () 2022-12-19 19:10:11 +11:00
feature_secure.md
feature_send_string.md Feature-ify Send String () 2022-07-02 22:10:08 +10:00
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md
feature_st7565.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md [Docs] Remove broken link () 2022-12-15 01:43:39 +11:00
feature_unicode.md Fixes unicode_map declaration example () 2022-12-31 21:23:17 +00:00
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flash_driver.md
flashing.md
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 [Docs] update git command and directory name of documents () 2019-12-12 20:59:00 -08:00
getting_started_make_guide.md
getting_started_vagrant.md
gpio_control.md
hand_wire.md
hardware_drivers.md Purge uGFX. () 2021-10-07 10:57:48 +11:00
hardware_keyboard_guidelines.md Add docs to cover recent LAYOUT_all lint checks () 2023-01-01 11:53:10 +11:00
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
isp_flashing_guide.md ISP flashing guide: add instructions for flashing STM32duino bootloader () 2022-03-13 23:55:47 +00:00
keycodes.md Fix RWIN typo within keycode list () 2022-11-28 05:25:56 +00:00
keycodes_basic.md
keycodes_magic.md
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) () 2022-02-06 17:36:44 +00:00
keymap.md
mod_tap.md
newbs.md [Docs] Use HTTPS for images and links where possible () 2021-01-30 22:00:56 +11:00
newbs_building_firmware.md Fix typo () 2022-09-29 11:50:32 +01:00
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.md
newbs_flashing.md Add note about qmk doctor in newbs_flashing.md () 2022-07-02 22:48:44 +10:00
newbs_getting_started.md
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md [Docs] Restructure of Git Best Practices doc () 2019-12-02 18:47:02 -08:00
newbs_git_resynchronize_a_branch.md
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md [Docs] Refactor code examples () 2022-08-12 17:27:24 -07: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 fix typo () 2022-11-29 16:34:20 +00:00
other_eclipse.md
other_vscode.md
platformdev_blackpill_f4x1.md weact docs patch re "security vulnerability" () 2023-01-12 22:29:25 +11:00
platformdev_chibios_earlyinit.md
platformdev_proton_c.md Add converter docs () 2022-07-08 22:49:16 +01:00
platformdev_rp2040.md [Core] Adjust PWM hardware audio driver for RP2040 () 2022-10-27 19:26:16 +02:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md [Docs] Touch up documentation templates & porting keyboard docs () 2023-01-13 02:58:38 -08:00
power.txt Trim trailing whitespace 2017-12-09 10:46:11 -05:00
pr_checklist.md Minor cleanup to breaking/checklist docs. () 2023-01-19 22:30:16 +11:00
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
quantum_painter.md
quantum_painter_qff.md
quantum_painter_qgf.md
quantum_painter_rle.md
README.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md Fix headers in info.json reference () 2022-11-30 02:45:51 +00:00
reference_keymap_extras.md
serial_driver.md
spi_driver.md
squeezing_avr.md Add Elite-Pi converter () 2022-09-08 14:59:27 -04:00
support.md
sw.js
syllabus.md
tap_hold.md
translating.md Add yet another dictionary for the QMK Firmware docs sidebar heading () 2019-11-28 22:14:04 +00:00
uart_driver.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt
ws2812_driver.md [Core] Allow custom timings for WS2812 PIO driver () 2022-11-10 07:58:15 +11:00

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.