Почетна Преглед Помоћ
Пријавите се
logic855
/
qmk_firmware
огледало од https://github.com/qmk/qmk_firmware.git
1
0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Дрво: 7fdb95af36
Гране Ознаке
qmk_firmware
/
docs
QMK Bot 70cc5809f9 Merge remote-tracking branch 'origin/master' into develop пре 5 година
..
ChangeLog 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) пре 5 година
de 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
es 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
fr-fr 59c572eaf0 Cleanup junk characters, part 1 (#13282) пре 5 година
gitbook 4580d3a730 RGB improvements (#1684) пре 9 година
he-il 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
ja 70cc5809f9 Merge remote-tracking branch 'origin/master' into develop пре 5 година
ko-kr 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
pt-br 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
ru-ru 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
zh-cn 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
.nojekyll 9e5676650e Use docsfy to replace gitbook пре 8 година
CNAME 4d26137e2a Create CNAME пре 8 година
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
_langs.md 10e8ed7430 [Docs] add README translation in portuguese (#7016) пре 6 година
_summary.md b2fdd48744 Add ST7565 LCD driver (#13089) пре 5 година
adc_driver.md 65c9752762 Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) пре 5 година
api_development_environment.md 99850aabca Add API documentation пре 6 година
api_development_overview.md 99850aabca Add API documentation пре 6 година
api_docs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) пре 6 година
audio_driver.md c80e5f9f88 Audio system overhaul (#11820) пре 5 година
breaking_changes.md e3030bff5e Merge remote-tracking branch 'upstream/master' into develop пре 5 година
breaking_changes_history.md 275996f4c1 Add changelog for 2021-05-29 Breaking Changes merge (#12939) пре 5 година
breaking_changes_instructions.md fced377ac0 2020 May 30 Breaking Changes Update (#9215) пре 6 година
chibios_upgrade_instructions.md 554c36a055 Update ChibiOS, ChibiOS-Contrib. (#13056) пре 5 година
cli.md fcf150bd82 Streamline the macos install process пре 6 година
cli_commands.md cb23fe9fc1 Move RGBLight code into its own folder (#13312) пре 5 година
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
cli_development.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
cli_tab_complete.md 588bcdc8ca Add support for tab completion (#12411) пре 5 година
coding_conventions_c.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
coding_conventions_python.md 66d94dc22a Move everything to Python 3.6 (#8835) пре 6 година
compatible_microcontrollers.md 8bb231aa1c Adds support for STM32L412xB, STM32L422xB. (#13383) пре 5 година
config_options.md 172e6a7030 Extensible split data sync (#11930) пре 5 година
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) пре 5 година
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
configurator_troubleshooting.md d5f34c4810 Polish Configurator section пре 6 година
contributing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) пре 6 година
custom_quantum_functions.md f287597c19 Use single memcmp to determine if matrix changed. (#13064) пре 5 година
data_driven_config.md ef6329af7c Create a system to map between info.json and config.h/rules.mk (#11548) пре 5 година
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) пре 6 година
documentation_templates.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
driver_installation_zadig.md 10096fc42e Zadig docs: add APM32 device name (#11356) пре 5 година
eeprom_driver.md dd16d3cc7e eeprom_i2c driver: added EXTERNAL_EEPROM_WP_PIN configuration option. (#12617) пре 5 година
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
faq_debug.md 4c3090ace9 Documentation changes SPLIT_USB_DETECT and hid_listen udev rules (#11665) пре 5 година
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) пре 5 година
faq_keymap.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
faq_misc.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) пре 5 година
feature_audio.md 2538d341d8 Document user song list file (#13101) пре 5 година
feature_auto_shift.md c02137a0d2 Add Per Key functionality for AutoShift (#11536) пре 5 година
feature_backlight.md 06aea834c4 Backlight: add defines for default level and breathing state (#12560) пре 5 година
feature_bluetooth.md 0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) пре 5 година
feature_bootmagic.md 789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347) пре 6 година
feature_combo.md 49abff9071 changed type of process_combo_event argument in tutorial (#10621) пре 5 година
feature_command.md a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) пре 7 година
feature_debounce_type.md a0959f1b33 Add asym_eager_defer_pk debounce type (#12689) пре 5 година
feature_dip_switch.md c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772) пре 6 година
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) пре 6 година
feature_encoders.md a0fed0ea17 Convert Encoder callbacks to be boolean functions (#12805) пре 5 година
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) пре 7 година
feature_haptic_feedback.md e4c5b1bbbb Add Per Key exclusions for Haptic Feedback (#12386) пре 5 година
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) пре 6 година
feature_joystick.md c66df16644 2020 November 28 Breaking Changes Update (#11053) пре 5 година
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) пре 5 година
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) пре 7 година
feature_leader_key.md 26b9b3aa23 feat: infinite timeout for leader key (#6580) пре 5 година
feature_led_indicators.md 1ff5ee255f Indicator LEDs as config (#10816) пре 5 година
feature_led_matrix.md 875bb48a20 Top level heading for common config (LED Matrix) (#13153) пре 5 година
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) пре 5 година
feature_midi.md b10728edc1 [Docs] added basic midi documention of common features (#13113) пре 5 година
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) пре 5 година
feature_oled_driver.md 0311c8036d Add oled_invert (#13172) пре 5 година
feature_pointing_device.md 711388d3e3 Merge remote-tracking branch 'origin/master' into develop пре 5 година
feature_ps2_mouse.md 92543a7cb5 fix(feature_ps2_mouse): fix Scroll Button example (#11669) пре 5 година
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) пре 5 година
feature_rgb_matrix.md 653082235a Relocate RGB/HSV color defs to a more fitting place (#13377) пре 5 година
feature_rgblight.md 653082235a Relocate RGB/HSV color defs to a more fitting place (#13377) пре 5 година
feature_sequencer.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) пре 5 година
feature_space_cadet.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
feature_split_keyboard.md 172e6a7030 Extensible split data sync (#11930) пре 5 година
feature_st7565.md 37fba09021 ST7565 invert (#13237) пре 5 година
feature_stenography.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
feature_swap_hands.md f0b30e0027 Make Swap Hands use PROGMEM (#12284) пре 5 година
feature_tap_dance.md 653ecf91c2 More Tap Dance docs improvements (#12358) пре 5 година
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) пре 6 година
feature_thermal_printer.md 4c675a83ba Format keycode tables пре 8 година
feature_unicode.md 04ab5de73c Deprecate `send_unicode_hex_string()` (#12602) пре 5 година
feature_userspace.md 501f2fdef1 Normalise include statements in core code (#11153) пре 5 година
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) пре 7 година
feature_wpm.md 180a32ec59 Enhancement of WPM feature (#11727) пре 5 година
flashing.md 891d18d356 Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600) пре 5 година
flashing_bootloadhid.md 235da6973d Install bootloadHid as part of qmk_install (#7463) пре 6 година
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) пре 5 година
getting_started_docker.md e4d3ff2374 Add support for using podman to util/docker_build.sh (#10819) пре 5 година
getting_started_github.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) пре 6 година
getting_started_make_guide.md b23eeb6a14 Documentation update (#12484) пре 5 година
getting_started_vagrant.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
hand_wire.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
hardware_avr.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
hardware_drivers.md d13ada1162 Add customisable EEPROM driver selection (#7274) пре 6 година
hardware_keyboard_guidelines.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
how_keyboards_work.md d5316e9714 Update URL for `60-keyboard.hwdb` (#7185) пре 6 година
i2c_driver.md 5d5cbb877d Rework I2C driver docs (#11658) пре 5 година
index.html bbf0f65284 Simplify the visual flow of the getting started page (#11316) пре 5 година
internals_defines.md ae7284edb8 rename api docs to internals пре 8 година
internals_gpio_control.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
internals_input_callback_reg.md ae7284edb8 rename api docs to internals пре 8 година
internals_midi_device.md ae7284edb8 rename api docs to internals пре 8 година
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals пре 8 година
internals_midi_util.md ae7284edb8 rename api docs to internals пре 8 година
internals_send_functions.md ae7284edb8 rename api docs to internals пре 8 година
internals_sysex_tools.md ae7284edb8 rename api docs to internals пре 8 година
isp_flashing_guide.md 9d1d875a95 [Docs] Update isp_flashing_guide.md (#11777) пре 5 година
keycodes.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) пре 5 година
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) пре 5 година
keycodes_us_ansi_shifted.md 40de65eac4 Backslash-escape pipe character in keycode lists (#7157) пре 6 година
keymap.md 142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081) пре 6 година
mod_tap.md 7e832e46de Add Mac centric Shift and Alt + GUI Macros (#13107) пре 5 година
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
newbs_building_firmware.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
newbs_building_firmware_configurator.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
newbs_flashing.md 0f516d9026 A few small typo fixes in docs (#12524) пре 5 година
newbs_getting_started.md 189e0d5b98 Update FreeBSD install method (#12815) пре 5 година
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) пре 6 година
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) пре 6 година
newbs_git_resynchronize_a_branch.md 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) пре 6 година
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
newbs_learn_more_resources.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
one_shot_keys.md c00a9937f2 [Docs] Update one_shot_keys.md (#12291) пре 5 година
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) пре 5 година
other_vscode.md a2af0a352b Update other_vscode.md of Japanese document (#10604) пре 5 година
platformdev_chibios_earlyinit.md 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) пре 5 година
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) пре 6 година
power.txt bb53635f33 Trim trailing whitespace пре 8 година
pr_checklist.md 268d0efa7e [Docs] pr_checklist: fix capitalization of Vial (#13301) пре 5 година
proton_c_conversion.md 87291437bd Add board specific to Proton-C, with usual defaults turned on. (#10976) пре 5 година
qmk.css ccc87421e7 Some more tweaks to make everything look nice пре 8 година
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) пре 5 година
quantum_keycodes.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
redirects.json d569f08771 Configuration system for CLI (#6708) пре 7 година
ref_functions.md bf1c40d682 [Docs] Add EEP_RST keycode to "Wiping the EEPROM" section (#11830) пре 5 година
reference_configurator_support.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
reference_glossary.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
reference_info_json.md a0e7333915 Merge remote-tracking branch 'origin/master' into develop пре 5 година
reference_keymap_extras.md e190872b82 Improved Language Specific Keycodes for US International and Extended Layouts (#11307) пре 5 година
serial_driver.md d9610120de Add Full-duplex serial driver for ARM boards (#9842) пре 5 година
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop пре 5 година
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
sw.js 303f425c6b Fix up info boxes. пре 8 година
syllabus.md 9b70e53508 [Docs] Fixed minor typos (#8860) пре 6 година
tap_hold.md 3559284839 Update IGNORE_MOD_TAP_INTERRUPT (#11452) пре 5 година
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) пре 6 година
uart_driver.md 30b46fad57 UART driver refactor (#11637) пре 5 година
understanding_qmk.md d1806a26e4 Split transport mirror (#11046) пре 5 година
unit_testing.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores пре 9 година
ws2812_driver.md 597d2e0e7b Fix up WS2812 SPI driver on F072. (#13022) пре 5 година

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.