poz/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
qmk_firmware/docs
History
Ryan 812001de7f
Deprecate ONESHOT_* keycodes for QK_ONE_SHOT_* (#18844) 
* Deprecate `ONESHOT_*` keycodes for `QK_ONE_SHOT_*`

* Docs
2022-10-25 17:50:22 +01:00
..
ChangeLog 2022q3 Changelog. (#18180) 2022-08-28 14:20:52 +10:00
gitbook/images
internals
ja Merge remote-tracking branch 'origin/master' into develop 2022-10-24 23:28:56 -07:00
zh-cn [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
.nojekyll Use docsfy to replace gitbook 2018-05-07 22:46:26 -07:00
_langs.md
_summary.md Merge remote-tracking branch 'origin/master' into develop 2022-10-20 21:30:35 +00:00
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md Remove legacy keycodes, part 5 (#18710) 2022-10-15 22:29:43 +01:00
api_overview.md
arm_debugging.md
audio_driver.md
breaking_changes.md 2022q3 Changelog. (#18180) 2022-08-28 14:20:52 +10:00
breaking_changes_history.md 2022q3 Changelog. (#18180) 2022-08-28 14:20:52 +10:00
breaking_changes_instructions.md
chibios_upgrade_instructions.md
cli.md
cli_commands.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
cli_configuration.md
cli_development.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
cli_tab_complete.md
CNAME
coding_conventions_c.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
coding_conventions_python.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
compatible_microcontrollers.md
config_options.md Implement split comms watchdog (#18599) 2022-10-06 20:52:42 +11:00
configurator_architecture.md
configurator_default_keymaps.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
configurator_diagram.drawio
configurator_diagram.svg
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 2022-09-19 02:20:22 +01:00
data_driven_config.md [Docs] Fix typo in data driven config docs (#18095) 2022-08-18 18:18:51 -07:00
documentation_best_practices.md
documentation_templates.md [Docs] Fix link to keyboard layout editor (#18801) 2022-10-22 12:39:49 -07:00
driver_installation_zadig.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
easy_maker.md
eeprom_driver.md
faq_build.md
faq_debug.md Remove legacy Debug keycode (#18769) 2022-10-19 11:33:05 +01:00
faq_general.md
faq_keymap.md
faq_misc.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
feature_advanced_keycodes.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 2022-09-19 02:20:22 +01:00
feature_audio.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
feature_auto_shift.md
feature_autocorrect.md [Core] Add getreuer's Autocorrect feature to core (#15699) 2022-09-17 17:50:54 +10:00
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_caps_word.md Deprecate CAPS_WORD/CAPSWRD for CW_TOGG (#18834) 2022-10-24 17:30:37 +01:00
feature_combo.md Use a macro to compute the size of arrays at compile time (#18044) 2022-08-30 10:20:04 +02:00
feature_command.md
feature_converters.md Add Elite-C to converters (#18309) 2022-09-18 20:30:27 +01:00
feature_debounce_type.md
feature_digitizer.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_eeprom.md Remove legacy EEPROM clear keycodes (#18782) 2022-10-20 12:20:07 +01:00
feature_encoders.md Resolve conflict merging master to develop (#18297) 2022-09-06 17:42:43 -04:00
feature_grave_esc.md
feature_haptic_feedback.md [Feature] Add support for multiple switchs/solenoids to Haptic Feedback engine (#15657) 2022-05-15 21:24:35 +10:00
feature_hd44780.md
feature_joystick.md Normalise Joystick and Programmable Button keycodes (#18832) 2022-10-24 15:50:33 +01:00
feature_key_lock.md Merge remote-tracking branch 'origin/master' into develop 2022-10-24 23:28:56 -07:00
feature_key_overrides.md Deprecate KEY_OVERRIDE_* keycodes for KO_* (#18843) 2022-10-25 14:45:57 +01:00
feature_layers.md [Docs] Extract 'Layer Change Code' and EEPROM (#18174) 2022-09-19 02:20:22 +01:00
feature_layouts.md
feature_leader_key.md Deprecate KC_LEAD for QK_LEAD (#18792) 2022-10-21 14:25:54 +01:00
feature_led_indicators.md quantum: led: split out led_update_ports() for customization of led behaviour (#14452) 2022-10-06 21:24:41 +11:00
feature_led_matrix.md Fix Per Key LED Indicator Callbacks (#18450) 2022-10-04 15:24:22 -07:00
feature_macros.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
feature_midi.md
feature_mouse_keys.md
feature_oled_driver.md docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
feature_pointing_device.md Allow Active High for Pointing Device Motion Pin (#18404) 2022-09-24 08:44:14 -07:00
feature_programmable_button.md Normalise Joystick and Programmable Button keycodes (#18832) 2022-10-24 15:50:33 +01:00
feature_ps2_mouse.md [Core] Rework PS/2 driver selection (#17892) 2022-08-31 09:16:07 +02:00
feature_rawhid.md
feature_rgb_matrix.md 4 Driver support for IS31FL3737 (#18750) 2022-10-18 08:26:58 +11:00
feature_rgblight.md Remove legacy Debug keycode (#18769) 2022-10-19 11:33:05 +01:00
feature_secure.md
feature_send_string.md
feature_sequencer.md
feature_space_cadet.md
feature_split_keyboard.md Remove legacy EEPROM clear keycodes (#18782) 2022-10-20 12:20:07 +01:00
feature_st7565.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md Update feature_tap_dance.md (#18509) 2022-09-28 20:22:59 +01:00
feature_thermal_printer.md
feature_unicode.md Remove UNICODE_KEY_OSX and UC_OSX (#18290) 2022-09-06 18:07:08 +01:00
feature_userspace.md
feature_velocikey.md Deprecate VLK_TOG for VK_TOGG (#18807) 2022-10-22 21:45:20 +01:00
feature_wpm.md
flash_driver.md
flashing.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
flashing_bootloadhid.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
fuse.txt
getting_started_docker.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
gpio_control.md
hand_wire.md
hardware_drivers.md
hardware_keyboard_guidelines.md
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html
isp_flashing_guide.md
keycodes.md Deprecate ONESHOT_* keycodes for QK_ONE_SHOT_* (#18844) 2022-10-25 17:50:22 +01:00
keycodes_basic.md Chromeos keycodes (#18212) 2022-09-17 15:48:09 +10:00
keycodes_magic.md
keycodes_us_ansi_shifted.md
keymap.md Remove legacy international keycodes (#18588) 2022-10-09 14:51:09 +11:00
mod_tap.md
newbs.md
newbs_building_firmware.md Fix typo (#18526) 2022-09-29 11:50:32 +01:00
newbs_building_firmware_configurator.md
newbs_building_firmware_workflow.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
other_eclipse.md
other_vscode.md
platformdev_blackpill_f4x1.md [Docs] Update platformdev_blackpill_f411.md (#18666) 2022-10-20 14:29:57 -07:00
platformdev_chibios_earlyinit.md [Docs] RESET -> QK_BOOT (#18365) 2022-09-15 01:03:55 +01:00
platformdev_proton_c.md Add converter docs (#17593) 2022-07-08 22:49:16 +01:00
platformdev_rp2040.md Merge remote-tracking branch 'origin/master' into develop 2022-10-05 01:38:10 +00:00
platformdev_selecting_arm_mcu.md
porting_your_keyboard_to_qmk.md
power.txt
pr_checklist.md Grammar Fix for PR Checklist (#18540) 2022-09-30 05:28:12 +01:00
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
quantum_painter.md [QP] Add RGB565 surface. Docs clarification, cleanup, tabsification, and reordering. (#18396) 2022-09-19 07:30:08 +10:00
quantum_painter_qff.md
quantum_painter_qgf.md Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
quantum_painter_rle.md
README.md
redirects.json
ref_functions.md Remove legacy EEPROM clear keycodes (#18782) 2022-10-20 12:20:07 +01:00
reference_configurator_support.md
reference_glossary.md
reference_info_json.md [docs] Improve documentation regarding info.json (#18508) 2022-09-29 13:08:45 -04:00
reference_keymap_extras.md
serial_driver.md spelling fix (#18831) 2022-10-24 17:18:03 +01:00
spi_driver.md
squeezing_avr.md Add Elite-Pi converter (#18236) 2022-09-08 14:59:27 -04:00
support.md
sw.js
syllabus.md
tap_hold.md docs: fix typos (#18671) 2022-10-13 20:02:15 +01:00
translating.md
uart_driver.md
understanding_qmk.md [Docs] Update 'Process Record' according to the code (#18209) 2022-09-03 13:46:42 -04: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.