Home Explore Help
Sign In
logic855
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Files Issues 0 Wiki
Branch: changelog
Branches Tags
qmk_firmware
/
docs
Zach White 4cfe36d6d0 Generate an initial changelog and a script to generate it 5 years ago
..
ChangeLog 4cfe36d6d0 Generate an initial changelog and a script to generate it 5 years ago
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
fr-fr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
gitbook 4580d3a730 RGB improvements (#1684) 9 years ago
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
ja a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 years ago
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 years ago
CNAME 4d26137e2a Create CNAME 8 years ago
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 years ago
_summary.md 30b46fad57 UART driver refactor (#11637) 5 years ago
adc_driver.md 8a4a0c25fd Change analogRead calls to analogReadPin (#9023) 6 years ago
api_development_environment.md 99850aabca Add API documentation 6 years ago
api_development_overview.md 99850aabca Add API documentation 6 years ago
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 years ago
breaking_changes.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
cli.md fcf150bd82 Streamline the macos install process 6 years ago
cli_commands.md d9785ec313 Improve the compile and flash subcommands (#11334) 5 years ago
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 years ago
compatible_microcontrollers.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 years ago
config_options.md 501f2fdef1 Normalise include statements in core code (#11153) 5 years ago
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 years ago
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 years ago
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 years ago
custom_quantum_functions.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
data_driven_config.md a15c9057a1 Document how to add data driven configurations (#11502) 5 years ago
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 years ago
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) 5 years ago
eeprom_driver.md 70f40339c2 Add i2c 24LC64 eeprom (#11200) 5 years ago
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
faq_debug.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 years ago
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 years ago
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
feature_advanced_keycodes.md 0cb7133e0d Doc followup 9942 (#10473) 5 years ago
feature_audio.md d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110) 7 years ago
feature_auto_shift.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_backlight.md d92ffd1157 Adds AT90USB162 support (#11570) 5 years ago
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 years ago
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) 6 years ago
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) 5 years ago
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 7 years ago
feature_debounce_type.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) 6 years ago
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 years ago
feature_encoders.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 years ago
feature_haptic_feedback.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 years ago
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
feature_layers.md 61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352) 6 years ago
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 years ago
feature_leader_key.md 294cfd8d33 Delete trailing period in documentation (#9416) 6 years ago
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) 5 years ago
feature_led_matrix.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
feature_macros.md 415d683ea7 Remove unused `action_get_macro()` usages in user files (#11165) 5 years ago
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 years ago
feature_oled_driver.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
feature_pointing_device.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 years ago
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) 5 years ago
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 years ago
feature_rgb_matrix.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 years ago
feature_rgblight.md d65db68f9f Merge remote-tracking branch 'upstream/master' into develop 5 years ago
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
feature_split_keyboard.md 5e2b53541b Add modifier state to the split keyboard transport (#10400) 5 years ago
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
feature_swap_hands.md 805f5cb72b One shot support for swap hands (#8590) 6 years ago
feature_tap_dance.md 9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259) 6 years ago
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 years ago
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 years ago
feature_unicode.md b5c2e5e8fd Fix documentation so UCIS example compiles. (#11541) 5 years ago
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 years ago
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) 7 years ago
feature_wpm.md bfb2f8e0a8 Add Word Per Minute calculation feature (#8054) 6 years ago
flashing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) 6 years ago
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
getting_started_docker.md 0fbcb41c85 Reintegrate previous docker docs (#9084) 6 years ago
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 years ago
getting_started_make_guide.md 944cf6476e Update docs/getting_started_make_guide.md (#11373) 5 years ago
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 years ago
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 years ago
i2c_driver.md 346bfb2a05 Update i2c_driver.md (#10131) 6 years ago
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 years ago
internals_defines.md ae7284edb8 rename api docs to internals 8 years ago
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 years ago
internals_midi_device.md ae7284edb8 rename api docs to internals 8 years ago
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 years ago
internals_midi_util.md ae7284edb8 rename api docs to internals 8 years ago
internals_send_functions.md ae7284edb8 rename api docs to internals 8 years ago
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 years ago
isp_flashing_guide.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
keycodes.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 years ago
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 years ago
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 years ago
mod_tap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
newbs_flashing.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
newbs_getting_started.md 162842f16e [Docs] add qmk setup home parameter (#11451) 5 years ago
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 years ago
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 years ago
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
one_shot_keys.md 078586b21a Update one_shot_keys.md (#10917) 5 years ago
other_eclipse.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) 5 years ago
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 years ago
power.txt bb53635f33 Trim trailing whitespace 8 years ago
pr_checklist.md 94e94ffb5b Recommend use of LED Indicator config (#10895) 5 years ago
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 years ago
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 years ago
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 years ago
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 years ago
redirects.json d569f08771 Configuration system for CLI (#6708) 6 years ago
ref_functions.md 2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370) 5 years ago
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop 5 years ago
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) 5 years ago
serial_driver.md 990d5189d1 Configurable serial usart timeout (#11057) 5 years ago
spi_driver.md d92ffd1157 Adds AT90USB162 support (#11570) 5 years ago
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 years ago
sw.js 303f425c6b Fix up info boxes. 8 years ago
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) 6 years ago
tap_hold.md c66df16644 2020 November 28 Breaking Changes Update (#11053) 5 years ago
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 years ago
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 years ago
understanding_qmk.md 5117dff6a2 Add Post Processing to process_record (#4892) 6 years ago
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 years ago
ws2812_driver.md 3d70766327 Add BGR byte order for WS2812 drivers (#11562) 5 years ago

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](newbs_building_firmware_configurator.md)
User friendly graphical interfaces, no programming knowledge required. ?> **Advanced** [Use The Source](newbs.md)
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.