qmk_firmware/docs
Nick Brassel 87291437bd
Add board specific to Proton-C, with usual defaults turned on. ()
- Set all other ChibiOS defaults to 'off', when not targeting Proton-C
- Modified all existing F303 boards to point at the QMK_PROTON_C to ensure repeatable binary output
- Modified version.h generation so that SKIP_VERSION=yes generates the same output
2020-12-03 13:04:28 +11:00
..
ChangeLog 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
de
es
fr-fr
gitbook/images
he-il
ja Add board specific to Proton-C, with usual defaults turned on. () 2020-12-03 13:04:28 +11:00
ko-kr Adding few Korean translated files () 2020-11-10 06:11:04 +11:00
pt-br
ru-ru
zh-cn
_langs.md
_summary.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
.nojekyll
adc_driver.md
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
breaking_changes_instructions.md
breaking_changes.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
cli_commands.md CI: Add docs build and deploy workflow () 2020-11-10 07:00:40 -08:00
cli_configuration.md
cli_development.md
cli.md
CNAME
coding_conventions_c.md
coding_conventions_python.md
compatible_microcontrollers.md
config_options.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
configurator_default_keymaps.md
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
documentation_best_practices.md
documentation_templates.md
driver_installation_zadig.md
eeprom_driver.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
feature_advanced_keycodes.md
feature_audio.md
feature_auto_shift.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_backlight.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_bluetooth.md
feature_bootmagic.md
feature_combo.md
feature_command.md
feature_debounce_type.md
feature_dip_switch.md
feature_dynamic_macros.md
feature_encoders.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_grave_esc.md
feature_haptic_feedback.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_hd44780.md
feature_joystick.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_key_lock.md
feature_layers.md
feature_layouts.md
feature_leader_key.md
feature_led_indicators.md Indicator LEDs as config () 2020-11-08 22:31:16 +00:00
feature_led_matrix.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_macros.md
feature_mouse_keys.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_oled_driver.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_pointing_device.md
feature_ps2_mouse.md
feature_rawhid.md
feature_rgb_matrix.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_rgblight.md Added color wheel that have QMK HSV values. () 2020-11-10 15:57:43 +11:00
feature_sequencer.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
feature_space_cadet.md
feature_split_keyboard.md [Docs] Add VBUS hack for teensys () 2020-11-27 21:03:31 -08:00
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
feature_velocikey.md
feature_wpm.md
flashing_bootloadhid.md
flashing.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 New command: qmk lint () 2020-11-07 09:56:08 -08:00
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html [Docs] redirect from /tutorial to /newbs () 2020-11-09 20:33:15 -08:00
internals_defines.md
internals_gpio_control.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
internals_input_callback_reg.md
internals_midi_device_setup_process.md
internals_midi_device.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md
keycodes_basic.md
keycodes_us_ansi_shifted.md
keycodes.md
keymap.md
mod_tap.md
newbs_building_firmware_configurator.md
newbs_building_firmware.md
newbs_flashing.md
newbs_getting_started.md Refactor qmk_install.sh () 2020-11-26 14:37:54 +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
newbs_testing_debugging.md
newbs.md [Docs] redirect from /tutorial to /newbs () 2020-11-09 20:33:15 -08:00
one_shot_keys.md Update one_shot_keys.md () 2020-11-18 21:31:21 +00:00
other_eclipse.md
other_vscode.md
platformdev_chibios_earlyinit.md
platformdev_selecting_arm_mcu.md
power.txt
pr_checklist.md Recommend use of LED Indicator config () 2020-11-16 14:16:42 +11:00
proton_c_conversion.md Add board specific to Proton-C, with usual defaults turned on. () 2020-12-03 13:04:28 +11:00
qmk_custom_dark.css
qmk_custom_light.css
qmk.css
quantum_keycodes.md
README.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md
reference_info_json.md
reference_keymap_extras.md
serial_driver.md Configurable serial usart timeout () 2020-11-30 03:29:35 -08:00
spi_driver.md
support.md
sw.js
syllabus.md
tap_hold.md 2020 November 28 Breaking Changes Update () 2020-11-28 12:02:18 -08:00
translating.md
understanding_qmk.md
unit_testing.md
usb_nkro.txt
ws2812_driver.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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

Totally new to QMK? There are two ways to get started:

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.