Acasă Explorează Ajutor
Autentificare
logic855
/
qmk_firmware
oglindă de https://github.com/qmk/qmk_firmware.git
1
0
Bifurcare 1
Fisiere Probleme 0 Wiki
Arbore: 0e34efd9a2
Ramuri Etichete
qmk_firmware
/
docs
Dasky 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 ani în urmă
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) 5 ani în urmă
de ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 ani în urmă
es ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 ani în urmă
fr-fr ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 ani în urmă
gitbook 4580d3a730 RGB improvements (#1684) 9 ani în urmă
he-il c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 ani în urmă
ja 10362777a5 update compatible_microcontrollers.md translation (#14401) 4 ani în urmă
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 ani în urmă
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 ani în urmă
ru-ru c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 ani în urmă
zh-cn ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 ani în urmă
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 ani în urmă
CNAME 4d26137e2a Create CNAME 8 ani în urmă
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 ani în urmă
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) 6 ani în urmă
_summary.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 5 ani în urmă
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 ani în urmă
api_development_environment.md 99850aabca Add API documentation 6 ani în urmă
api_development_overview.md 99850aabca Add API documentation 6 ani în urmă
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 ani în urmă
audio_driver.md c80e5f9f88 Audio system overhaul (#11820) 5 ani în urmă
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 ani în urmă
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) 5 ani în urmă
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 ani în urmă
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) 5 ani în urmă
cli.md fcf150bd82 Streamline the macos install process 6 ani în urmă
cli_commands.md 3b28178deb `--parallel` improvements (#13800) 5 ani în urmă
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 ani în urmă
cli_development.md fdcea06336 CLI/Docs: Fix the format commands' name (#13668) 5 ani în urmă
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) 5 ani în urmă
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) 6 ani în urmă
compatible_microcontrollers.md b43c6bc176 Add support for STM32F407x MCUs. (#13718) 5 ani în urmă
config_options.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 ani în urmă
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 ani în urmă
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 5 ani în urmă
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 ani în urmă
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 ani în urmă
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 ani în urmă
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 ani în urmă
contributing.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 ani în urmă
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 ani în urmă
custom_quantum_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) 5 ani în urmă
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 ani în urmă
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
driver_installation_zadig.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 ani în urmă
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) 5 ani în urmă
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) 5 ani în urmă
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
faq_debug.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 ani în urmă
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 ani în urmă
faq_keymap.md bb356a1584 [Docs] Update path to keycode.h (#14263) 5 ani în urmă
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) 5 ani în urmă
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 5 ani în urmă
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 ani în urmă
feature_backlight.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 ani în urmă
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 ani în urmă
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) 5 ani în urmă
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) 5 ani în urmă
feature_digitizer.md 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 5 ani în urmă
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 ani în urmă
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) 6 ani în urmă
feature_encoders.md 703f027717 Allow for removal of hysteresis on 4x encoders (#13698) 5 ani în urmă
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) 7 ani în urmă
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) 5 ani în urmă
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) 6 ani în urmă
feature_joystick.md 9e77cdf4e6 Bugfix for Joystick and JSON schema (#14295) 5 ani în urmă
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers 6 ani în urmă
feature_key_overrides.md 1e7117317f Documentation: Fix links in key overrides (#14228) 5 ani în urmă
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) 5 ani în urmă
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) 7 ani în urmă
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 ani în urmă
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 ani în urmă
feature_led_matrix.md 7f80076d04 Align rgb/led matrix docs with current behaviour (#14367) 5 ani în urmă
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) 5 ani în urmă
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) 5 ani în urmă
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) 5 ani în urmă
feature_oled_driver.md 657323a206 [Docs] fixed incorrect amount of steps for oled usage (#13519) 4 ani în urmă
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop 5 ani în urmă
feature_ps2_mouse.md 07553b41f0 [Feature] Swap buttons on PS2 Mouse/Trackball (#9205) 5 ani în urmă
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 ani în urmă
feature_rgb_matrix.md 7f80076d04 Align rgb/led matrix docs with current behaviour (#14367) 5 ani în urmă
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) 5 ani în urmă
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 ani în urmă
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
feature_split_keyboard.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) 4 ani în urmă
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 ani în urmă
feature_stenography.md 705774f7bf Steno combinedkeys (#12538) 5 ani în urmă
feature_swap_hands.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 ani în urmă
feature_tap_dance.md 03d258c222 matrix_scan_x -> x_task (#13748) 5 ani în urmă
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) 6 ani în urmă
feature_thermal_printer.md 4c675a83ba Format keycode tables 8 ani în urmă
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) 5 ani în urmă
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) 5 ani în urmă
feature_velocikey.md 8a8fdd9a72 Highlight keycode (#14317) 5 ani în urmă
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) 5 ani în urmă
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 ani în urmă
flashing_bootloadhid.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 ani în urmă
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 ani în urmă
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) 5 ani în urmă
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 ani în urmă
getting_started_make_guide.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) 5 ani în urmă
getting_started_vagrant.md b705020daf move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 5 ani în urmă
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) 5 ani în urmă
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) 5 ani în urmă
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) 6 ani în urmă
hardware_keyboard_guidelines.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) 6 ani în urmă
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) 5 ani în urmă
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) 5 ani în urmă
internals_defines.md ae7284edb8 rename api docs to internals 8 ani în urmă
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 8 ani în urmă
internals_midi_device.md ae7284edb8 rename api docs to internals 8 ani în urmă
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 8 ani în urmă
internals_midi_util.md ae7284edb8 rename api docs to internals 8 ani în urmă
internals_send_functions.md ae7284edb8 rename api docs to internals 8 ani în urmă
internals_sysex_tools.md ae7284edb8 rename api docs to internals 8 ani în urmă
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) 5 ani în urmă
keycodes.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) 5 ani în urmă
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) 5 ani în urmă
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 6 ani în urmă
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) 6 ani în urmă
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) 5 ani în urmă
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 ani în urmă
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers 6 ani în urmă
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 ani în urmă
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) 5 ani în urmă
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) 5 ani în urmă
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 ani în urmă
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 ani în urmă
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 6 ani în urmă
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 ani în urmă
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 ani în urmă
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 ani în urmă
one_shot_keys.md fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) 5 ani în urmă
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) 5 ani în urmă
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 ani în urmă
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 ani în urmă
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 ani în urmă
power.txt bb53635f33 Trim trailing whitespace 8 ani în urmă
pr_checklist.md b459f314ec Explicitly state that VIA should not be enabled in the default keymap. (#13803) 5 ani în urmă
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 ani în urmă
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 ani în urmă
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 ani în urmă
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 ani în urmă
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers 6 ani în urmă
redirects.json d569f08771 Configuration system for CLI (#6708) 6 ani în urmă
ref_functions.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 5 ani în urmă
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) 5 ani în urmă
reference_info_json.md 4791cfae1a Remove width, height and key_count from info.json (#14274) 4 ani în urmă
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) 5 ani în urmă
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 ani în urmă
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop 5 ani în urmă
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 ani în urmă
sw.js 303f425c6b Fix up info boxes. 8 ani în urmă
syllabus.md a03aa301de Remove Full Bootmagic (#13846) 5 ani în urmă
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) 5 ani în urmă
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 ani în urmă
uart_driver.md 30b46fad57 UART driver refactor (#11637) 5 ani în urmă
understanding_qmk.md 52cfc9259b [Feature] Key Overrides (#11422) 5 ani în urmă
unit_testing.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 ani în urmă
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 ani în urmă
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) 5 ani în urmă

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.