You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kiilerix da6d6ce2e1
Some docs improvements (#15845)
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't

It is not strictly necessary to use LAYOUT macros in keyboard.c, but it
is a convenient abstraction of hardware internals, allowing focus on the
physical keyboard layout.

From the C source point of view LAYOUT is macro with a parameter list,
which expands to a array of rows that each is an array with a keyboard
scancode for each column. A macro parameter list is not an array, and
even less a single array.

Perhaps no big deal, but also no reason to give incorrect hints.

* docs: update "Understanding QMK's Code" to current code structure introduced in 96e2b13d1d

This part of the documentation was no longer correct. I tried updating
it, mainly copy editing and using github links to latest release.

This is not trying to fix all problems, but just trying to fix some
problems while reusing much of the old phrases and structure.

* Update docs to use "qmk format-python"
4 years ago
..
README.md [Core] [Docs] Remove travis-ci references (#13916) 4 years ago
_summary.md [Docs] Update Japanese faq documents (#12842) 5 years ago
adc_driver.md [Docs] Japanese translation of adc_driver.md (#10971) 5 years ago
api_development_environment.md [Docs] Japanese translation of api_*.md (#9992) 5 years ago
api_development_overview.md [Docs] Japanese translation of api_*.md (#9992) 5 years ago
api_docs.md [Update] Change Original TAGs of Japanese translations (#13396) 5 years ago
api_overview.md [Update] Change Original TAGs of Japanese translations (#13396) 5 years ago
arm_debugging.md
breaking_changes.md [Core] [Docs] Remove travis-ci references (#13916) 4 years ago
breaking_changes_instructions.md
cli.md
cli_commands.md Some docs improvements (#15845) 4 years ago
cli_configuration.md Update Japanese newbs_getting_started.md (#12841) 5 years ago
cli_development.md Some docs improvements (#15845) 4 years ago
coding_conventions_c.md [Update] Change Original TAGs of Japanese translations (#13396) 5 years ago
coding_conventions_python.md
compatible_microcontrollers.md Initial pass of F405 support (#14584) 4 years ago
config_options.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
configurator_step_by_step.md
configurator_troubleshooting.md
contributing.md Update Japanese document (#14769) 4 years ago
custom_matrix.md [Docs] Japanese translation of docs/pr_checklist.md (#10415) 5 years ago
custom_quantum_functions.md [Docs] update suspend_*_user examples (#14542) 4 years ago
data_driven_config.md [Docs] Japanese translation of docs/data_driven_config.md (#12066) 5 years ago
documentation_best_practices.md Update tags to check for document updates (#10606) 5 years ago
documentation_templates.md [Update] Change Original TAGs of Japanese translations (#13396) 5 years ago
driver_installation_zadig.md
faq_build.md [Docs] Update Japanese getting started documents. (#12806) 5 years ago
faq_debug.md [Docs] Update Japanese faq documents (#12842) 5 years ago
faq_general.md [Update] Change Original TAGs of Japanese translations (#13473) 4 years ago
faq_keymap.md Move tmk_core/common/<plat> (#13918) 4 years ago
faq_misc.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
feature_advanced_keycodes.md [Docs] update Japanese translation of feature_advanced_keycodes.md (#14309) 4 years ago
feature_audio.md Remove FAUXCLICKY feature (deprecated) (#11829) 5 years ago
feature_auto_shift.md Update Japanese document. (#10591) 5 years ago
feature_backlight.md [Docs] update Japanese translation of feature_backlight.md (#14403) 4 years ago
feature_bluetooth.md Update feature_bluetooth.md of Japanese document. (#10594) 5 years ago
feature_bootmagic.md Fix some additional bootmagic settings (#13979) 4 years ago
feature_combo.md [Docs] Update feature_combo.md of Japanese document (#10671) 5 years ago
feature_command.md
feature_debounce_type.md Remove backwards compatibility of debounce names (#13877) 4 years ago
feature_dip_switch.md Added right vs left specific pin assignments for dip switch (#13074) 4 years ago
feature_dynamic_macros.md Update tags to check for document updates (#10606) 5 years ago
feature_encoders.md [Docs] Modify encoder_update_user example to return false (#14541) 4 years ago
feature_grave_esc.md
feature_haptic_feedback.md Split out HAPTIC_ENABLE to have separate DRIVER option (#14854) 4 years ago
feature_hd44780.md
feature_key_lock.md
feature_layers.md Move tmk_core/common/<plat> (#13918) 4 years ago
feature_layouts.md
feature_leader_key.md [Docs] update Japanese translation of feature_leader_key.md (#13669) 4 years ago
feature_led_indicators.md [Docs] update Japanese translation of pr_checklist.md (#13693) 4 years ago
feature_led_matrix.md Remove use of __flash due to LTO issues (#15268) 4 years ago
feature_macros.md Add ID to "## Advanced Macros". (#12830) 5 years ago
feature_mouse_keys.md Add support for 8 buttons to mouse report (#10807) 5 years ago
feature_pointing_device.md [Docs] update Japanese translation of feature_pointing_device.md (#12753) 5 years ago
feature_ps2_mouse.md Align PS/2 GPIO defines (#14745) 4 years ago
feature_rawhid.md update feature_rawhid.md translation (#12759) 5 years ago
feature_split_keyboard.md [Docs] Update Japanese translation of feature_split_keyboard.md (#10283) 5 years ago
feature_stenography.md Call steno_set_mode inside eeconfig_init_user in the doc (#15176) 4 years ago
feature_swap_hands.md [Update] Change Original TAGs of Japanese translations (#13473) 4 years ago
feature_tap_dance.md Merge remote-tracking branch 'origin/master' into develop 4 years ago
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md [Docs] Japanese translation of feature_unicode.md (#10985) 5 years ago
feature_userspace.md [Update] Change Original TAGs of Japanese translations (#13473) 4 years ago
feature_velocikey.md Remove `BOOTMAGIC_ENABLE = lite` option (#15002) 4 years ago
feature_wpm.md
flashing.md [Docs] Use HTTPS for images and links where possible (#11695) 5 years ago
flashing_bootloadhid.md
getting_started_docker.md [Docs] Update Japanese getting started documents. (#12806) 5 years ago
getting_started_github.md Purge uGFX. (#14720) 4 years ago
getting_started_introduction.md
getting_started_make_guide.md [Docs] Update Japanese getting started documents. (#12806) 5 years ago
getting_started_vagrant.md move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 4 years ago
hardware_avr.md Port new_keyboard.sh to CLI (#13706) 4 years ago
hardware_drivers.md Purge uGFX. (#14720) 4 years ago
hardware_keyboard_guidelines.md Purge uGFX. (#14720) 4 years ago
how_a_matrix_works.md [Update] Change Original TAGs of Japanese translations (#13396) 5 years ago
how_keyboards_work.md
i2c_driver.md Align ChibiOS I2C defs with other drivers (#14399) 4 years ago
internals_defines.md [Docs] Japanese translation of internals_*.md (#10316) 5 years ago
internals_gpio_control.md [Docs] update Japanese translation of internals_gpio_control.md (#13401) 4 years ago
internals_input_callback_reg.md Ensure single newline at EOF for core files (#11310) 5 years ago
internals_midi_device.md [Docs] Japanese translation of internals_*.md (#10316) 5 years ago
internals_midi_device_setup_process.md [Docs] Japanese translation of internals_*.md (#10316) 5 years ago
internals_midi_util.md [Docs] Japanese translation of internals_*.md (#10316) 5 years ago
internals_send_functions.md [Docs] Japanese translation of internals_*.md (#10316) 5 years ago
internals_sysex_tools.md [Docs] Japanese translation of internals_*.md (#10316) 5 years ago
isp_flashing_guide.md [Docs] update Japanese translation of isp_flashing_guide.md (#13700) 4 years ago
ja_doc_status.sh add docs/ja/ja_doc_status.sh (#14402) 4 years ago
keycodes.md [Docs] Japanese translation of docs/keycodes.md (#10192) 5 years ago
keycodes_basic.md [Docs] Japanese translation of docs/keycodes_basic.md (#11044) 5 years ago
keycodes_us_ansi_shifted.md Translate keycodes us ansi shifted (#13820) 4 years ago
keymap.md
mod_tap.md [Docs] update Japanese translation of mod_tap.md (#13981) 4 years ago
newbs.md Update Japanese newbs.md document. (#12835) 5 years ago
newbs_building_firmware.md
newbs_building_firmware_configurator.md Update Japanese newbs_building_firmware_configurator.md document. (#12836) 5 years ago
newbs_flashing.md [Docs] Update Japanese newbs_flashing.md (#12837) 5 years ago
newbs_getting_started.md Remove unwanted notes (#13563) 4 years ago
newbs_git_best_practices.md
newbs_git_resolving_merge_conflicts.md
newbs_git_resynchronize_a_branch.md
newbs_git_using_your_master_branch.md
newbs_learn_more_resources.md [Docs] Update Japanese newbs_learn_more_resources.md (#12839) 5 years ago
newbs_testing_debugging.md [Docs] Update Japanese faq documents (#12842) 5 years ago
one_shot_keys.md [Docs] update Japanese translation of one_shot_keys.md (#13656) 4 years ago
other_eclipse.md [Docs] update Japanese translation of other_eclipse.md (#12776) 5 years ago
other_vscode.md [Core] [Docs] Remove travis-ci references (#13916) 4 years ago
pr_checklist.md Move tmk_core/common/<plat> (#13918) 4 years ago
proton_c_conversion.md [Update] Change Original TAGs of Japanese translations (#13473) 4 years ago
quantum_keycodes.md [Docs] Japanese translation of docs/quantum_keycodes.md (#10137) 5 years ago
ref_functions.md update ref_functions.md translation (#12784) 5 years ago
reference_configurator_support.md Remove references to info.json `width` and `height` in CLI (#13728) 4 years ago
reference_glossary.md [Update] Change Original TAGs of Japanese translations (#13396) 5 years ago
reference_info_json.md Remove width, height and key_count from info.json (#14274) 4 years ago
reference_keymap_extras.md Added mac variant of portuguese keymap extras (#11260) 5 years ago
serial_driver.md [Docs] Japanese translation of docs/serial_driver.md (#10014) 5 years ago
support.md [Docs] Japanese translation of docs/support.md (#10015) 5 years ago
syllabus.md Update Japanese document (#14767) 4 years ago
tap_hold.md [Docs] update Japanese translation of tap_hold.md (#12820) 5 years ago
translating.md [Docs] Japanese translation of docs/translating.md (#10018) 5 years ago
understanding_qmk.md Merge remote-tracking branch 'origin/master' into develop 4 years ago

README.md

Quantum Mechanical Keyboard Firmware

現在のバージョン Discord ドキュメントの状態 GitHub 貢献者 GitHub フォーク

QMK ファームウェアとは何でしょうか?

QMK (Quantum Mechanical Keyboard)は、コンピュータ入力デバイスの開発を中心としたオープンソースコミュニティです。コミュニティには、キーボード、マウス、MIDI デバイスなど、全ての種類の入力デバイスが含まれます。協力者の中心グループは、QMK ファームウェアQMK ConfiguratorQMK ツールボックスqmk.fm、そして、このドキュメントを、あなたのようなコミュニティメンバーの助けを借りて保守しています。

始めましょう

QMK は初めてですか始めるには2つの方法があります:

自分用にアレンジします

QMK には、探求すべき多くの機能と、深く知るためのリファレンスドキュメントがたくさんあります。ほとんどの機能はキーマップを変更し、キーコードを変更することで活用されます。

手助けが必要ですか?

サポートページ をチェックして、QMK の使い方について手助けを得る方法を確認してください。

貢献する

QMK コミュニティに貢献する方法はたくさんあります。始める最も簡単な方法は、それを使って友人に QMK という単語を広めることです。