You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk-fw/docs
Nick Brassel 8dc2502177
Add PR checklist document. (#9913)
* Add PR checklist document.

* Update docs/pr_checklist.md

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* Reword the lower/raise/adjust suggestion somewhat for clarity.

* Add suggestion from @Didel for coding conventions.

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
5 years ago
..
ChangeLog 2020 May 30 Breaking Changes Update (#9215) 5 years ago
de Fix capitalisation of "GitHub" (#9184) 5 years ago
es Remove `DESCRIPTION` (#9732) 5 years ago
fr-fr Fix capitalisation of "GitHub" (#9184) 5 years ago
gitbook/images
he-il Fix capitalisation of "GitHub" (#9184) 5 years ago
ja [Docs] Update Japanese translation of newbs_flashing.md. (#9819) 5 years ago
pt-br Fix capitalisation of "GitHub" (#9184) 5 years ago
ru-ru Fix capitalisation of "GitHub" (#9184) 5 years ago
zh-cn Remove unnecessary break after return from documentation (#9892) 5 years ago
.nojekyll
CNAME
README.md
_langs.md
_summary.md Add PR checklist document. (#9913) 5 years ago
adc_driver.md adds support for the atmega328 (#9043) 5 years ago
api_development_environment.md
api_development_overview.md
api_docs.md
api_overview.md
arm_debugging.md
breaking_changes.md 2020 May 30 Breaking Changes Update (#9215) 5 years ago
breaking_changes_instructions.md 2020 May 30 Breaking Changes Update (#9215) 5 years ago
cli.md Streamline the macos install process 5 years ago
cli_commands.md [CLI] Add a subcommand for getting information about a keyboard (#8666) 5 years ago
cli_configuration.md Fix capitalisation of "GitHub" (#9184) 5 years ago
cli_development.md Fix capitalisation of "GitHub" (#9184) 5 years ago
coding_conventions_c.md Update C coding conventions to match .clang-format config for i… (#8717) 5 years ago
coding_conventions_python.md Move everything to Python 3.6 (#8835) 5 years ago
compatible_microcontrollers.md adds support for the atmega328 (#9043) 5 years ago
config_options.md Remove `DESCRIPTION` (#9732) 5 years ago
configurator_step_by_step.md Fix capitalisation of "GitHub" (#9184) 5 years ago
configurator_troubleshooting.md
contributing.md
custom_matrix.md
custom_quantum_functions.md Remove unnecessary break after return from documentation (#9892) 5 years ago
documentation_best_practices.md [Docs] fix file path (#9540) 5 years ago
documentation_templates.md
driver_installation_zadig.md MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736) 5 years ago
eeprom_driver.md Add SPI 25xx EEPROM support. (#8780) 5 years ago
faq_build.md Docs: update ModemManager recommendation (#9328) 5 years ago
faq_debug.md Remove Atmel FLIP from install scripts and documentation (#8822) 5 years ago
faq_general.md
faq_keymap.md
feature_advanced_keycodes.md Add *OPT aliases for *ALT keycodes and macros (#8714) 5 years ago
feature_audio.md
feature_auto_shift.md
feature_backlight.md Backlight docs wordsmithing (#9631) 5 years ago
feature_bluetooth.md
feature_bootmagic.md
feature_combo.md
feature_command.md
feature_debounce_type.md quantum/debounce: Added sym_pk debounce algorithm (#8587) 5 years ago
feature_dip_switch.md add DIP_SWITCH_MATRIX_GRID support (#8772) 5 years ago
feature_dynamic_macros.md Allowing Pressing the Start Buttons Again to Stop Dynamic Macro Recording (#9446) 5 years ago
feature_encoders.md Adding information to feature_encoders.md (#9486) 5 years ago
feature_grave_esc.md
feature_haptic_feedback.md
feature_hd44780.md fixed typo for clear lcd screen function in hd44780 docs (#9086) 5 years ago
feature_key_lock.md
feature_layers.md Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 5 years ago
feature_layouts.md
feature_leader_key.md Delete trailing period in documentation (#9416) 5 years ago
feature_led_matrix.md
feature_macros.md [Docs] Improve Unicode documentation (#8676) 5 years ago
feature_mouse_keys.md Implemented New MK_COMBINED Functionality (#9557) 5 years ago
feature_oled_driver.md OLED driver function to set pixels (#9713) 5 years ago
feature_pointing_device.md Include `pointing_device_send` in docs (#9185) 5 years ago
feature_ps2_mouse.md Add movement hook to ps2_mouse (#8805) 5 years ago
feature_rawhid.md Allow for overriding RAW endpoint usage page and ID. (#8834) 5 years ago
feature_rgb_matrix.md Add Indicator flag for RGB Matrix (#9933) 5 years ago
feature_rgblight.md Improve keycode handling for RGB (#7677) 5 years ago
feature_space_cadet.md
feature_split_keyboard.md add SPLIT_HAND_MATRIX_GRID support (#8685) 5 years ago
feature_stenography.md fix typo (#9695) 5 years ago
feature_swap_hands.md One shot support for swap hands (#8590) 5 years ago
feature_tap_dance.md Clean up Tap Dance docs (#9372) 5 years ago
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md [Docs] Improve Unicode documentation (#8676) 5 years ago
feature_userspace.md [Docs] Fixed the hyperlink to `/users/_example/`. (#9326) 5 years ago
feature_velocikey.md
feature_wpm.md
flashing.md Remove Atmel FLIP from install scripts and documentation (#8822) 5 years ago
flashing_bootloadhid.md
fuse.txt
getting_started_docker.md Reintegrate previous docker docs (#9084) 5 years ago
getting_started_github.md Fix capitalisation of "GitHub" (#9184) 5 years ago
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md Remove Atmel FLIP from install scripts and documentation (#8822) 5 years ago
hand_wire.md
hardware_avr.md Remove `DESCRIPTION` (#9732) 5 years ago
hardware_drivers.md
hardware_keyboard_guidelines.md [Docs] added the description of the reading order of the rules.mk files. (#8566) 5 years ago
how_a_matrix_works.md
how_keyboards_work.md
i2c_driver.md
index.html Add redirect for old getting started links (#8987) 5 years ago
internals_defines.md
internals_gpio_control.md add 'togglePin' convenience function (#8734) 5 years ago
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 [Docs] Update ISP Guide (#9748) 5 years ago
keycodes.md Add OS compatibility matrix for basic keycodes (#8557) 5 years ago
keycodes_basic.md Add *OPT aliases for *ALT keycodes and macros (#8714) 5 years ago
keycodes_us_ansi_shifted.md
keymap.md [Docs] Clarify layer transparency keymap.md (#9081) 5 years ago
mod_tap.md Add *OPT aliases for *ALT keycodes and macros (#8714) 5 years ago
newbs.md
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_flashing.md [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077) 5 years ago
newbs_getting_started.md Update newbs MSYS2 pacman instructions (#9445) 5 years ago
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 [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380) 5 years ago
other_eclipse.md
other_vscode.md [Docs] small text and formatting fixes in vscode manual (#9156) 5 years ago
platformdev_chibios_earlyinit.md Add support for hardware and board initialisation overrides. (#8330) 5 years ago
platformdev_selecting_arm_mcu.md Add documentation for selecting an Arm MCU (#9046) 5 years ago
power.txt
pr_checklist.md Add PR checklist document. (#9913) 5 years ago
proton_c_conversion.md Update ARM split keyboard docs (#9160) 5 years ago
qmk.css
qmk_custom_dark.css
qmk_custom_light.css
quantum_keycodes.md
redirects.json
ref_functions.md Remove unnecessary break after return from documentation (#9892) 5 years ago
reference_configurator_support.md
reference_glossary.md fixed link to Eclipse instructions (#9647) 5 years ago
reference_info_json.md
reference_keymap_extras.md [Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644) 5 years ago
serial_driver.md Update ARM split keyboard docs (#9160) 5 years ago
spi_driver.md adds support for the atmega328 (#9043) 5 years ago
support.md Fix capitalisation of "GitHub" (#9184) 5 years ago
sw.js
syllabus.md [Docs] Fixed minor typos (#8860) 5 years ago
tap_hold.md Add missing bracket for Tap-Hold code sample (#9675) 5 years ago
translating.md
understanding_qmk.md Add Post Processing to process_record (#4892) 5 years ago
unit_testing.md Edit Unit Testing Documentation (#8961) 5 years ago
usb_nkro.txt
ws2812_driver.md Fix incorrect delay when setting WS2812 (and similar) leds (#9302) 5 years ago

README.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.