ホーム エクスプローラ ヘルプ
サインイン
logic855
/
qmk_firmware
同期ミラー https://github.com/qmk/qmk_firmware.git
1
0
フォーク 1
ファイル 課題 0 Wiki
ツリー: 2481e109a0
ブランチ タグ
qmk_firmware
/
docs
Path Nirvana f314705921 adding uf2 flash support for blackpill 401 (#13968) 5 年 前
..
ChangeLog 0c175d63cf Update 20210529.md (#13170) 5 年 前
de ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 年 前
es ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 年 前
fr-fr ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 年 前
gitbook 4580d3a730 RGB improvements (#1684) 9 年 前
he-il c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 年 前
ja ce379ef458 Merge remote-tracking branch 'origin/master' into develop 5 年 前
ko-kr c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 年 前
pt-br c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 年 前
ru-ru c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 年 前
zh-cn ce379ef458 Merge remote-tracking branch 'origin/master' into develop 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 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 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 ce379ef458 Merge remote-tracking branch 'origin/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 3b28178deb `--parallel` improvements (#13800) 5 年 前
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 年 前
cli_development.md fdcea06336 CLI/Docs: Fix the format commands' name (#13668) 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 b43c6bc176 Add support for STM32F407x MCUs. (#13718) 5 年 前
config_options.md 488aaa0980 Enable sync of OLED/ST7565 display on/off state on Splits (#13542) 5 年 前
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 年 前
configurator_default_keymaps.md de68d294ec [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 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 c71d67ba3f [Core] [Docs] Remove travis-ci references (#13916) 5 年 前
custom_matrix.md 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906) 6 年 前
custom_quantum_functions.md a03aa301de Remove Full Bootmagic (#13846) 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 a03aa301de Remove Full Bootmagic (#13846) 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 fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 年 前
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 年 前
faq_keymap.md a03aa301de Remove Full Bootmagic (#13846) 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 4e3726bfe1 Fixup Audio startup and add to documents (#13606) 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 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 75b49aff56 Digitizer HID interface : absolute coordinates for mouse cursor (#12851) 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 703f027717 Allow for removal of hysteresis on 4x encoders (#13698) 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_key_overrides.md 52cfc9259b [Feature] Key Overrides (#11422) 5 年 前
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 8f6867ce95 [Docs] Added note about no split support (#12512) 5 年 前
feature_led_matrix.md 7da97c293d Rgb matrix/enable modes explicitly (#13758) 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 07553b41f0 [Feature] Swap buttons on PS2 Mouse/Trackball (#9205) 5 年 前
feature_rawhid.md dee506c096 Updated Raw HID docs to clarify packet/report length (#11211) 5 年 前
feature_rgb_matrix.md 7da97c293d Rgb matrix/enable modes explicitly (#13758) 5 年 前
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 0ae20e7457 Make solo half of split keyboards (more) usable. (#13523) 5 年 前
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 年 前
feature_stenography.md 705774f7bf Steno combinedkeys (#12538) 5 年 前
feature_swap_hands.md f0b30e0027 Make Swap Hands use PROGMEM (#12284) 5 年 前
feature_tap_dance.md 03d258c222 matrix_scan_x -> x_task (#13748) 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 aeff347a07 Update feature_wpm.md (#13936) 5 年 前
flashing.md f314705921 adding uf2 flash support for blackpill 401 (#13968) 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 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 d13ada1162 Add customisable EEPROM driver selection (#7274) 6 年 前
hardware_keyboard_guidelines.md a03aa301de Remove Full Bootmagic (#13846) 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 a03aa301de Remove Full Bootmagic (#13846) 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 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 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 b459f314ec Explicitly state that VIA should not be enabled in the default keymap. (#13803) 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 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 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年 前
reference_info_json.md 25f43837d2 Remove references to info.json `width` and `height` in CLI (#13728) 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 52cfc9259b [Feature] Key Overrides (#11422) 5 年 前
unit_testing.md fc9fb2c775 Allow output of logging when running unit tests (#13556) 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.