Почетна Преглед Помоћ
Пријавите се
logic855
/
qmk_firmware
огледало од https://github.com/qmk/qmk_firmware.git
1
0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Дрво: dace4d5f0d
Гране Ознаке
qmk_firmware
/
docs
Ryan db41a3426c Improve Adafruit BLE configuration defines (#14749) пре 4 година
..
ChangeLog 6caebb7b61 Bootmagic lite docs clarity. (#14204) пре 5 година
de 596c4a1f87 Remove bin/qmk (#14231) пре 5 година
es b2a186cf92 Purge uGFX. (#14720) пре 4 година
fr-fr b2a186cf92 Purge uGFX. (#14720) пре 4 година
gitbook 4580d3a730 RGB improvements (#1684) пре 9 година
he-il b2a186cf92 Purge uGFX. (#14720) пре 4 година
ja 7c5233e097 Merge remote-tracking branch 'origin/master' into develop пре 4 година
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) пре 5 година
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) пре 5 година
ru-ru b2a186cf92 Purge uGFX. (#14720) пре 4 година
zh-cn b2a186cf92 Purge uGFX. (#14720) пре 4 година
.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 83988597f4 Add Support for USB programmable buttons (#12950) пре 5 година
adc_driver.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) пре 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 b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
breaking_changes.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) пре 5 година
breaking_changes_history.md 4bad375d7c 2021Q3 pre-merge `develop` changelog, keyboard aliases (#14198) пре 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 590b405468 New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) (#14370) пре 5 година
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
cli_development.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
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 1a9e7b95ab Change `MK66F18` -> `MK66FX1M0` (#14659) пре 4 година
config_options.md 02ab7b1888 [Core] Fix "6kro enable" and clarify naming (#14563) пре 4 година
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_default_keymaps.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) пре 5 година
configurator_step_by_step.md e4823aadec Fix capitalisation of "GitHub" (#9184) пре 6 година
configurator_troubleshooting.md d5f34c4810 Polish Configurator section пре 6 година
contributing.md 596c4a1f87 Remove bin/qmk (#14231) пре 5 година
custom_matrix.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
custom_quantum_functions.md 45f88af4a1 [Docs] update suspend_*_user examples (#14542) пре 4 година
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 d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) пре 5 година
easy_maker.md 60a36863bc [Keyboard] ez_maker/directpins for easy one-offs in qmk_configurator (#13321) пре 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 b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) пре 5 година
faq_keymap.md bb356a1584 [Docs] Update path to keycode.h (#14263) пре 5 година
faq_misc.md d8f0c8783a Remove sysex API (#14723) пре 4 година
feature_advanced_keycodes.md 92dd1b977b Additional documentation for GUI mod combo (#13266) пре 5 година
feature_audio.md 4e3726bfe1 Fixup Audio startup and add to documents (#13606) пре 5 година
feature_auto_shift.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) пре 5 година
feature_backlight.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_bluetooth.md db41a3426c Improve Adafruit BLE configuration defines (#14749) пре 4 година
feature_bootmagic.md a03aa301de Remove Full Bootmagic (#13846) пре 5 година
feature_combo.md 7e983796e1 Process combos earlier & overlapping combos (#8591) пре 5 година
feature_command.md a03aa301de Remove Full Bootmagic (#13846) пре 5 година
feature_debounce_type.md c0628c2820 Remove backwards compatibility of debounce names (#13877) пре 5 година
feature_digitizer.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) пре 5 година
feature_dynamic_macros.md cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085) пре 6 година
feature_encoders.md 19e33b685f [Docs] Modify encoder_update_user example to return false (#14541) пре 4 година
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) пре 7 година
feature_haptic_feedback.md eb5b24f97c Add LM() keys to the list of keys disabled by NO_HAPTIC_MOD (#14181) пре 4 година
feature_hd44780.md d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086) пре 6 година
feature_joystick.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_key_lock.md 54c58ea6de Add explicit id tags to externally linked headers пре 6 година
feature_key_overrides.md 1e7117317f Documentation: Fix links in key overrides (#14228) пре 5 година
feature_layers.md eac9ee8d3f Improve upon the 'Caveats' section of the Layers and Mod-Tap documentation (#12306) пре 5 година
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_leader_key.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) пре 5 година
feature_led_indicators.md 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) пре 5 година
feature_led_matrix.md ddb6821b97 [Docs] fix wrong directory for RGB Matrix animations (#14494) пре 4 година
feature_macros.md 2395069b0b [Docs] New section to modifier docs: Checking Modifier State (#10550) пре 5 година
feature_midi.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_mouse_keys.md 99f3df2893 Add support for 8 buttons to mouse report (#10807) пре 5 година
feature_oled_driver.md 657323a206 [Docs] fixed incorrect amount of steps for oled usage (#13519) пре 5 година
feature_pointing_device.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_programmable_button.md 83988597f4 Add Support for USB programmable buttons (#12950) пре 5 година
feature_ps2_mouse.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_rgb_matrix.md c38a730805 Merge remote-tracking branch 'upstream/master' into develop пре 4 година
feature_rgblight.md fb9a254a43 Retain brightness with lighting layers (#13025) пре 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 12a8e59e9c [Docs] add sync options heading, update led indicators (#14441) пре 5 година
feature_st7565.md 37fba09021 ST7565 invert (#13237) пре 5 година
feature_stenography.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_swap_hands.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_tap_dance.md 13f3e30e86 Fix link from feature_tap_dance.md to tapping term settings (#14741) пре 4 година
feature_terminal.md b23f6011c3 Remove build option firmware size impacts (#6947) пре 6 година
feature_thermal_printer.md 4c675a83ba Format keycode tables пре 8 година
feature_unicode.md 1646c0f26c 2021 May 29 Breaking Changes Update (#13034) пре 5 година
feature_userspace.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
feature_velocikey.md 8a8fdd9a72 Highlight keycode (#14317) пре 5 година
feature_wpm.md aeff347a07 Update feature_wpm.md (#13936) пре 5 година
flashing.md d5cb7de5e4 Change USBasp and bootloadHID bootloaders to lowercase (#14354) пре 5 година
flashing_bootloadhid.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) пре 5 година
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) пре 6 година
getting_started_make_guide.md d8f0c8783a Remove sysex API (#14723) пре 4 година
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
hand_wire.md 6fd9b2feba [Docs] Added information on soldering diodes in parallel (#13117) пре 5 година
hardware_avr.md b021c2f2c5 Port new_keyboard.sh to CLI (#13706) пре 5 година
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
hardware_keyboard_guidelines.md b2a186cf92 Purge uGFX. (#14720) пре 4 година
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) пре 5 година
how_keyboards_work.md b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
i2c_driver.md bc1f5ef381 i2c_master: Add support for reading/writing to 16-bit registers (#14289) пре 4 година
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 83988597f4 Add Support for USB programmable buttons (#12950) пре 5 година
keycodes_basic.md 962b8d3814 Update keycode docs (#11343) пре 5 година
keycodes_magic.md 4c4f632378 Add a toggle key for GUI On/Off in Magic feature (#13830) пре 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 27d9579fd5 Document examples on intercepting Mod-Tap (#14502) пре 4 година
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 b56282756b [Docs] Clean up some code block languages (#14434) пре 5 година
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 fcce9f2a4f fix: Fix typo in documentation for one shot keys. ON_TOGG -> OS_TOGG (#13754) пре 5 година
other_eclipse.md cfbd9ba0e7 eclipse: recommend changing the default project make target (#12447) пре 5 година
other_vscode.md c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) пре 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 4676a14596 More PR checklist updates (#14705) пре 4 година
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 a03aa301de Remove Full Bootmagic (#13846) пре 5 година
reference_configurator_support.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) пре 5 година
reference_glossary.md 014aa0661e Fix Space Cadet md link (#14300) пре 5 година
reference_info_json.md 4791cfae1a Remove width, height and key_count from info.json (#14274) пре 5 година
reference_keymap_extras.md fce12f0075 Rework keymap_extras docs (#13949) пре 5 година
serial_driver.md 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) пре 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 a03aa301de Remove Full Bootmagic (#13846) пре 5 година
tap_hold.md 610035dce8 Add HOLD_ON_OTHER_KEY_PRESS option for dual-role keys (#9404) пре 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 b2a186cf92 Purge uGFX. (#14720) пре 4 година
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) пре 4 година
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.