Startsida Utforska Hjälp
Logga in
logic855
/
qmk_firmware
spegling av https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Filer Ärenden 0 Wiki
Träd: dce611bc9f
Grenar Taggar
qmk_firmware
/
docs
adlainewson 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) 4 år sedan
..
ChangeLog 88fe5c16a5 Changelog 2021q4 (#15325) 4 år sedan
gitbook 4580d3a730 RGB improvements (#1684) 9 år sedan
ja 282e916d86 Remove use of __flash due to LTO issues (#15268) 4 år sedan
zh-cn 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 år sedan
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 år sedan
CNAME 4d26137e2a Create CNAME 8 år sedan
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 år sedan
_summary.md 88fe5c16a5 Changelog 2021q4 (#15325) 4 år sedan
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 år sedan
api_development_environment.md 99850aabca Add API documentation 6 år sedan
api_development_overview.md 99850aabca Add API documentation 6 år sedan
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 år sedan
audio_driver.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
breaking_changes.md 99ec5e39cf Fix last merge date (#15327) 4 år sedan
breaking_changes_history.md 88fe5c16a5 Changelog 2021q4 (#15325) 4 år sedan
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 år sedan
chibios_upgrade_instructions.md 5da04fb45b Update to ChibiOS 20.3.4, support builds against trunk (#14208) 4 år sedan
cli.md fcf150bd82 Streamline the macos install process 6 år sedan
cli_commands.md aecb387692 Add test filter to 'qmk pytest' (#15432) 4 år sedan
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
cli_tab_complete.md 0002acd4a3 Fix Typo in documentation (#14942) 4 år sedan
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
coding_conventions_python.md fefd7fdc51 Refactor new-keyboard to be python3.7 compatible (#14707) 4 år sedan
compatible_microcontrollers.md 0df93ec2f9 [Docs] Fix Header formatting in compatible mcu doc (#15438) 4 år sedan
config_options.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 år sedan
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 år sedan
configurator_default_keymaps.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 år sedan
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 år sedan
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 år sedan
contributing.md 596c4a1f87 Remove bin/qmk (#14231) 5 år sedan
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
custom_quantum_functions.md 36d123e9c5 Add support for deferred executors. (#14859) 4 år sedan
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 år sedan
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 år sedan
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
driver_installation_zadig.md e50867d52d [Core] Add support for RISC-V builds and GD32VF103 MCU (#12508) 4 år sedan
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 5 år sedan
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 år sedan
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
faq_debug.md 3f1f60cbf9 doc/faq_debug: qmk cli can also be used to print debug messages (#15528) 4 år sedan
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 år sedan
faq_keymap.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
faq_misc.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 år sedan
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 år sedan
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 år sedan
feature_auto_shift.md d9393b8684 Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (#11059) 4 år sedan
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
feature_bluetooth.md 8d604e707b [Docs] Updated typo on feature_bluetooth.md (#15466) 4 år sedan
feature_bootmagic.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 år sedan
feature_combo.md b384599663 Link Macro example for COMBO_ACTION documentation (#15164) 4 år sedan
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 år sedan
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 5 år sedan
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 år sedan
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 år sedan
feature_encoders.md 6f043c5497 Volume as default encoder documentation example (#15678) 4 år sedan
feature_grave_esc.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
feature_haptic_feedback.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 år sedan
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
feature_key_overrides.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
feature_layers.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 år sedan
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 år sedan
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 5 år sedan
feature_led_matrix.md 282e916d86 Remove use of __flash due to LTO issues (#15268) 4 år sedan
feature_macros.md a88dc08643 [Docs] Note the order of enumerated custom keycodes (#15706) 4 år sedan
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 år sedan
feature_oled_driver.md 464d67c68f Merge remote-tracking branch 'origin/master' into develop 4 år sedan
feature_pointing_device.md 2669b0bee8 [Docs] Add drag scrolling example to Pointing device docs page (#15715) 4 år sedan
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) 5 år sedan
feature_ps2_mouse.md 84d5198ef9 Align PS/2 GPIO defines (#14745) 4 år sedan
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
feature_rgb_matrix.md 8a4fae3b32 [Docs] Recommend the use of RGB matrix functions for code (#15744) 4 år sedan
feature_rgblight.md 63d3ad155a [Docs] Recommend the use of RGB light functions for code (#15745) 4 år sedan
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
feature_split_keyboard.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 5 år sedan
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 år sedan
feature_stenography.md aa712b5e28 Merge remote-tracking branch 'origin/master' into develop 4 år sedan
feature_swap_hands.md d8324e8a9c Document swap-hands tap-toggle feature (#15229) 4 år sedan
feature_tap_dance.md 0acc0924db [Docs] Update feature_tap_dance.md (#14931) 4 år sedan
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 år sedan
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 år sedan
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 år sedan
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 år sedan
feature_velocikey.md 84ea77ead6 Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 år sedan
feature_wpm.md c9fd698711 Reimplements WPM feature to be smaller & precise (#13902) 4 år sedan
flashing.md 755731f0ba Fix RESET not working for keyboards with Kiibohd bootloader (#15430) 4 år sedan
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 år sedan
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 år sedan
getting_started_make_guide.md 36d123e9c5 Add support for deferred executors. (#14859) 4 år sedan
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 år sedan
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 år sedan
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 år sedan
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) 4 år sedan
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) 4 år sedan
index.html 1c1e6fa47d Remove stale docs translations (#15737) 4 år sedan
internals_defines.md ae7284edb8 rename api docs to internals 8 år sedan
internals_gpio_control.md 2728603fe6 Move tmk_core/common/<plat> (#13918) 4 år sedan
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 år sedan
internals_midi_device.md ae7284edb8 rename api docs to internals 8 år sedan
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 år sedan
internals_midi_util.md ae7284edb8 rename api docs to internals 8 år sedan
internals_send_functions.md ae7284edb8 rename api docs to internals 8 år sedan
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 år sedan
isp_flashing_guide.md cc5a38e787 Rework ISP flashing guide (#14938) 4 år sedan
keycodes.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 år sedan
keycodes_basic.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 5 år sedan
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 år sedan
keymap.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
mod_tap.md 57f63e43d8 [Docs] Correct logic of tap hold statement (#14992) 4 år sedan
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 år sedan
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
newbs_flashing.md 069ef7eb9e [Docs] newbs_flashing.md: add link to build environment section (#15654) 4 år sedan
newbs_getting_started.md 9b912416b4 [Docs] Add instructions to create keymap before proceeding (#14945) 4 år sedan
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 år sedan
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 år sedan
newbs_git_resynchronize_a_branch.md b56282756b [Docs] Clean up some code block languages (#14434) 5 år sedan
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 år sedan
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 år sedan
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 år sedan
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 år sedan
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 år sedan
power.txt bb53635f33 Trim trailing whitespace 8 år sedan
pr_checklist.md 88fe5c16a5 Changelog 2021q4 (#15325) 4 år sedan
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 år sedan
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 år sedan
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 år sedan
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 år sedan
redirects.json d569f08771 Configuration system for CLI (#6708) 7 år sedan
ref_functions.md 435fa2c391 fix typo (#15569) 4 år sedan
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 år sedan
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 år sedan
reference_info_json.md b7a346600c [Docs] Clean up reference_info_json.md (#14806) 4 år sedan
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 år sedan
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 år sedan
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 år sedan
squeezing_avr.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 år sedan
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 år sedan
sw.js 303f425c6b Fix up info boxes. 8 år sedan
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 år sedan
tap_hold.md 4bac5f53d8 New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 4 år sedan
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 år sedan
uart_driver.md 04b51e381e Update UART driver API (#14839) 4 år sedan
understanding_qmk.md c2e0b283c3 [Docs] Reorder functions in Understanding QMK (#15357) 4 år sedan
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 år sedan
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 år sedan
ws2812_driver.md f889e26ed7 Documentation typo fix (#15298) 4 år sedan

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.