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
Tree: 972f8ba69a
Branches Tags
qmk_firmware
/
docs
s-show ab10ce4932 update feature_tap_dance.md translation (#13496) 5 years ago
..
ChangeLog 0c175d63cf Update 20210529.md (#13170) 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 59c572eaf0 Cleanup junk characters, part 1 (#13282) 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 ab10ce4932 update feature_tap_dance.md translation (#13496) 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 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 years ago
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 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
audio_driver.md c80e5f9f88 Audio system overhaul (#11820) 5 years ago
breaking_changes.md e7ddbc394b Update merge sequence to reflect no-ff, no-squash. (#13038) 5 years ago
breaking_changes_history.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 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 8b39a3c484 `qmk docs`: Add flag to open in browser (#13788) 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
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 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 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 years ago
config_options.md f173963d95 [Docs] Fix typos in audio config in main config page (#12928) 5 years ago
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 years ago
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 years ago
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 years ago
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 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 ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 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 6c550cc7f7 Improve driver installation docs (#13562) 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 fc9fb2c775 Allow output of logging when running unit tests (#13556) 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 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 years ago
feature_audio.md 2538d341d8 Document user song list file (#13101) 5 years ago
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 years ago
feature_backlight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 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 fd9d531bd9 [Docs] Remove extra word it bootmagic page (#13855) 5 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 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 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 6a5f29208e [Docs] Update feature_haptic_feedback.md (#11859) 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 eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 years ago
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 years ago
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 years ago
feature_led_indicators.md 8f6867ce95 [Docs] Added note about no split support (#12512) 5 years ago
feature_led_matrix.md 875bb48a20 Top level heading for common config (LED Matrix) (#13153) 5 years ago
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 years ago
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) 5 years ago
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 years ago
feature_oled_driver.md 2f08a34394 OLED driver tweaks (#13215) 5 years ago
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 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 fdf71f1aa7 [Docs] RGB Matrix Caps Lock and Layer indicator example (#13367) 5 years ago
feature_rgblight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 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 449b4b8d86 [Docs] Update feature_split_keyboard.md (#13205) 5 years ago
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
feature_swap_hands.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 years ago
feature_tap_dance.md ae2c2358ec [Docs] Add `default` case in Tap Dance Example 6 (#13727) 5 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 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 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 aeff347a07 Update feature_wpm.md (#13936) 5 years ago
flashing.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 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 e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 5 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 b23eeb6a14 Documentation update (#12484) 5 years ago
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 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 5d5cbb877d Rework I2C driver docs (#11658) 5 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 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 years ago
keycodes.md fa309df895 [Docs] added list of MIDI keycodes (#13159) 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 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) 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 0f516d9026 A few small typo fixes in docs (#12524) 5 years ago
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 years ago
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 years ago
other_vscode.md 9c69db4700 Updated settings.json file to fit VSC's docs (#13829) 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 b459f314ec Explicitly state that VIA should not be enabled in the default keymap. (#13803) 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 bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) 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 fce12f0075 Rework keymap_extras docs (#13949) 5 years ago
serial_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 years ago
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 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 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) 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 d1806a26e4 Split transport mirror (#11046) 5 years ago
unit_testing.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 years ago
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 years ago
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 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.