mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-01 23:45:54 +00:00

History

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"		2022-03-05 15:58:50 +11:00
..
_summary.md	[Docs] Update Japanese faq documents (#12842 )	2021-06-24 21:54:54 +09:00
adc_driver.md	[Docs] Japanese translation of adc_driver.md (#10971 )	2021-02-14 20:54:58 +09:00
api_development_environment.md	[Docs] Japanese translation of api_*.md (#9992 )	2020-09-03 19:54:23 -07:00
api_development_overview.md	[Docs] Japanese translation of api_*.md (#9992 )	2020-09-03 19:54:23 -07:00
api_docs.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
api_overview.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
arm_debugging.md	[Docs] Trivial documentation fix (#8509 )	2020-03-22 13:53:58 +11:00
breaking_changes_instructions.md	[Docs] Japanese translation of breaking_changes*.md (#8576 )	2020-06-21 20:17:16 +09:00
breaking_changes.md	[Core] [Docs] Remove travis-ci references (#13916 )	2021-08-20 23:31:26 +01:00
cli_commands.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
cli_configuration.md	Update Japanese newbs_getting_started.md (#12841 )	2021-06-24 21:53:47 +09:00
cli_development.md	Some docs improvements (#15845 )	2022-03-05 15:58:50 +11:00
cli.md	[Update] Japanese translation of docs/cli.md and docs/cli_commands.md (#9536 )	2020-06-28 20:27:06 +09:00
coding_conventions_c.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
coding_conventions_python.md	[Docs] Japanese translation of docs/coding_conventions_python.md (#9517 )	2020-07-12 11:43:43 +09:00
compatible_microcontrollers.md	Initial pass of F405 support (#14584 )	2021-09-25 00:19:41 +01:00
config_options.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
configurator_step_by_step.md	[Update] Japanese translation of docs/newbs_building_firmware_configurator.md (#9395 )	2020-06-24 18:10:52 +09:00
configurator_troubleshooting.md	[Update] Japanese translation of docs/newbs_building_firmware_configurator.md (#9395 )	2020-06-24 18:10:52 +09:00
contributing.md	Update Japanese document (#14769 )	2021-10-09 21:02:55 +01:00
custom_matrix.md	[Docs] Japanese translation of docs/pr_checklist.md (#10415 )	2020-10-14 05:08:26 +09:00
custom_quantum_functions.md	[Docs] update suspend_*_user examples (#14542 )	2021-09-21 16:40:19 -07:00
data_driven_config.md	[Docs] Japanese translation of docs/data_driven_config.md (#12066 )	2021-06-13 04:08:32 +09:00
documentation_best_practices.md	Update tags to check for document updates (#10606 )	2020-10-13 17:03:17 +09:00
documentation_templates.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
driver_installation_zadig.md	Japanese documents 'original document' comment fix (#9816 )	2020-07-25 08:38:13 +09:00
faq_build.md	[Docs] Update Japanese getting started documents. (#12806 )	2021-06-21 03:36:51 +09:00
faq_debug.md	[Docs] Update Japanese faq documents (#12842 )	2021-06-24 21:54:54 +09:00
faq_general.md	[Update] Change Original TAGs of Japanese translations (#13473 )	2021-07-08 18:47:09 +10:00
faq_keymap.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
faq_misc.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
feature_advanced_keycodes.md	[Docs] update Japanese translation of feature_advanced_keycodes.md (#14309 )	2021-09-23 13:01:42 +09:00
feature_audio.md	Remove FAUXCLICKY feature (deprecated) (#11829 )	2021-02-09 09:49:05 -08:00
feature_auto_shift.md	Update Japanese document. (#10591 )	2020-10-10 18:15:22 +09:00
feature_backlight.md	[Docs] update Japanese translation of feature_backlight.md (#14403 )	2021-09-23 13:02:32 +09:00
feature_bluetooth.md	Update feature_bluetooth.md of Japanese document. (#10594 )	2020-10-13 01:06:06 +09:00
feature_bootmagic.md	Fix some additional bootmagic settings (#13979 )	2021-08-12 13:03:40 -07:00
feature_combo.md	[Docs] Update feature_combo.md of Japanese document (#10671 )	2020-10-17 03:19:06 -07:00
feature_command.md	[Docs] Japanese translation of docs/feature_command.md (#8672 )	2020-04-20 14:49:12 +09:00
feature_debounce_type.md	Remove backwards compatibility of debounce names (#13877 )	2021-08-09 19:46:18 +01:00
feature_dip_switch.md	Added right vs left specific pin assignments for dip switch (#13074 )	2021-08-19 18:39:15 +01:00
feature_dynamic_macros.md	Update tags to check for document updates (#10606 )	2020-10-13 17:03:17 +09:00
feature_encoders.md	[Docs] Modify encoder_update_user example to return false (#14541 )	2021-09-21 07:52:57 -07:00
feature_grave_esc.md	[Docs] Japanese translation of docs/feature_grave_esc.md (#8873 )	2020-04-27 00:47:15 -07:00
feature_haptic_feedback.md	Split out HAPTIC_ENABLE to have separate DRIVER option (#14854 )	2021-10-18 12:55:44 +01:00
feature_hd44780.md	Japanese documents 'original document' comment fix (#9816 )	2020-07-25 08:38:13 +09:00
feature_key_lock.md	[Docs] Japanese translation of docs/feature_key_lock.md (#8948 )	2020-05-01 01:43:22 +09:00
feature_layers.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
feature_layouts.md	[Docs] Japanese translation of docs/feature_layouts.md (#8949 )	2020-05-18 20:29:04 -07:00
feature_leader_key.md	[Docs] update Japanese translation of feature_leader_key.md (#13669 )	2021-09-23 12:55:19 +09:00
feature_led_indicators.md	[Docs] update Japanese translation of pr_checklist.md (#13693 )	2021-09-24 14:51:34 +09:00
feature_led_matrix.md	Remove use of __flash due to LTO issues (#15268 )	2021-11-24 18:38:49 +11:00
feature_macros.md	Add ID to "## Advanced Macros". (#12830 )	2021-06-24 12:32:51 +10:00
feature_mouse_keys.md	Add support for 8 buttons to mouse report (#10807 )	2021-01-28 04:38:34 +11:00
feature_pointing_device.md	[Docs] update Japanese translation of feature_pointing_device.md (#12753 )	2021-06-13 04:15:08 +09:00
feature_ps2_mouse.md	Align PS/2 GPIO defines (#14745 )	2021-10-20 20:07:40 +01:00
feature_rawhid.md	update feature_rawhid.md translation (#12759 )	2021-06-08 02:36:42 +09:00
feature_split_keyboard.md	[Docs] Update Japanese translation of feature_split_keyboard.md (#10283 )	2020-09-11 13:10:30 -07:00
feature_stenography.md	Call steno_set_mode inside eeconfig_init_user in the doc (#15176 )	2021-11-17 22:30:42 +00:00
feature_swap_hands.md	[Update] Change Original TAGs of Japanese translations (#13473 )	2021-07-08 18:47:09 +10:00
feature_tap_dance.md	Merge remote-tracking branch 'origin/master' into develop	2021-08-17 16:14:10 +00:00
feature_terminal.md	[Docs] Japanese translation of docs/feature_terminal.md (#9033 )	2020-06-08 02:24:35 +09:00
feature_thermal_printer.md	[Docs] Japanese translation of docs/feature_thermal_printer.md (#9034 )	2020-05-18 19:58:04 -07:00
feature_unicode.md	[Docs] Japanese translation of feature_unicode.md (#10985 )	2021-02-14 20:52:54 +09:00
feature_userspace.md	[Update] Change Original TAGs of Japanese translations (#13473 )	2021-07-08 18:47:09 +10:00
feature_velocikey.md	Remove `BOOTMAGIC_ENABLE = lite` option (#15002 )	2021-11-05 08:18:09 +11:00
feature_wpm.md	[Docs] Japanese translation of docs/feature_wpm.md (#9254 )	2020-06-10 21:04:39 +09:00
flashing_bootloadhid.md	[Docs] Japanese translation of docs/flashing_bootloadhid.md (#9680 )	2020-07-25 09:33:20 +09:00
flashing.md	[Docs] Use HTTPS for images and links where possible (#11695 )	2021-01-30 22:00:56 +11:00
getting_started_docker.md	[Docs] Update Japanese getting started documents. (#12806 )	2021-06-21 03:36:51 +09:00
getting_started_github.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
getting_started_introduction.md	Update Japanese translation with prefix 'getting'	2020-03-31 18:30:21 +09:00
getting_started_make_guide.md	[Docs] Update Japanese getting started documents. (#12806 )	2021-06-21 03:36:51 +09:00
getting_started_vagrant.md	move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230 )	2021-08-29 16:41:56 -07:00
hardware_avr.md	Port new_keyboard.sh to CLI (#13706 )	2021-07-30 21:57:40 +01:00
hardware_drivers.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
hardware_keyboard_guidelines.md	Purge uGFX. (#14720 )	2021-10-07 10:57:48 +11:00
how_a_matrix_works.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
how_keyboards_work.md	[Docs] Japanese translation of docs/how_keyboards_work.md (#9683 )	2020-07-29 19:00:26 +09:00
i2c_driver.md	Align ChibiOS I2C defs with other drivers (#14399 )	2021-09-12 15:41:33 +01:00
internals_defines.md	[Docs] Japanese translation of internals_*.md (#10316 )	2021-02-01 12:51:46 +09:00
internals_gpio_control.md	[Docs] update Japanese translation of internals_gpio_control.md (#13401 )	2021-07-08 18:46:28 +10:00
internals_input_callback_reg.md	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
internals_midi_device_setup_process.md	[Docs] Japanese translation of internals_*.md (#10316 )	2021-02-01 12:51:46 +09:00
internals_midi_device.md	[Docs] Japanese translation of internals_*.md (#10316 )	2021-02-01 12:51:46 +09:00
internals_midi_util.md	[Docs] Japanese translation of internals_*.md (#10316 )	2021-02-01 12:51:46 +09:00
internals_send_functions.md	[Docs] Japanese translation of internals_*.md (#10316 )	2021-02-01 12:51:46 +09:00
internals_sysex_tools.md	[Docs] Japanese translation of internals_*.md (#10316 )	2021-02-01 12:51:46 +09:00
isp_flashing_guide.md	[Docs] update Japanese translation of isp_flashing_guide.md (#13700 )	2021-09-23 12:58:56 +09:00
ja_doc_status.sh	add docs/ja/ja_doc_status.sh (#14402 )	2021-10-16 17:31:09 +09:00
keycodes_basic.md	[Docs] Japanese translation of docs/keycodes_basic.md (#11044 )	2021-07-01 18:21:03 +09:00
keycodes_us_ansi_shifted.md	Translate keycodes us ansi shifted (#13820 )	2021-10-08 19:28:00 +09:00
keycodes.md	[Docs] Japanese translation of docs/keycodes.md (#10192 )	2021-03-05 00:20:01 +09:00
keymap.md	[Docs] Update Japanese translation of keymap.md. (#9807 )	2020-07-31 17:25:20 -07:00
mod_tap.md	[Docs] update Japanese translation of mod_tap.md (#13981 )	2021-10-01 17:24:53 +09:00
newbs_building_firmware_configurator.md	Update Japanese newbs_building_firmware_configurator.md document. (#12836 )	2021-06-08 02:43:21 +09:00
newbs_building_firmware.md	[Docs] Update Japanese translation of newbs_building_firmware.md. (#9810 )	2020-07-31 17:57:31 -07:00
newbs_flashing.md	[Docs] Update Japanese newbs_flashing.md (#12837 )	2021-06-13 04:11:56 +09:00
newbs_getting_started.md	Remove unwanted notes (#13563 )	2021-07-16 09:37:49 -07:00
newbs_git_best_practices.md	The TAGs of the original document has been updated to facilitate future verification. (#9285 )	2020-06-05 21:49:34 +09:00
newbs_git_resolving_merge_conflicts.md	The TAGs of the original document has been updated to facilitate future verification. (#9285 )	2020-06-05 21:49:34 +09:00
newbs_git_resynchronize_a_branch.md	The TAGs of the original document has been updated to facilitate future verification. (#9285 )	2020-06-05 21:49:34 +09:00
newbs_git_using_your_master_branch.md	The TAGs of the original document has been updated to facilitate future verification. (#9285 )	2020-06-05 21:49:34 +09:00
newbs_learn_more_resources.md	[Docs] Update Japanese newbs_learn_more_resources.md (#12839 )	2021-06-14 15:31:50 +09:00
newbs_testing_debugging.md	[Docs] Update Japanese faq documents (#12842 )	2021-06-24 21:54:54 +09:00
newbs.md	Update Japanese newbs.md document. (#12835 )	2021-06-13 04:10:23 +09:00
one_shot_keys.md	[Docs] update Japanese translation of one_shot_keys.md (#13656 )	2021-09-23 12:52:53 +09:00
other_eclipse.md	[Docs] update Japanese translation of other_eclipse.md (#12776 )	2021-07-01 18:22:48 +09:00
other_vscode.md	[Core] [Docs] Remove travis-ci references (#13916 )	2021-08-20 23:31:26 +01:00
pr_checklist.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
proton_c_conversion.md	[Update] Change Original TAGs of Japanese translations (#13473 )	2021-07-08 18:47:09 +10:00
quantum_keycodes.md	[Docs] Japanese translation of docs/quantum_keycodes.md (#10137 )	2020-09-03 19:01:37 -07:00
README.md	[Core] [Docs] Remove travis-ci references (#13916 )	2021-08-20 23:31:26 +01:00
ref_functions.md	update ref_functions.md translation (#12784 )	2021-06-08 02:41:33 +09:00
reference_configurator_support.md	Remove references to info.json `width` and `height` in CLI (#13728 )	2021-07-29 22:37:18 -07:00
reference_glossary.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
reference_info_json.md	Remove width, height and key_count from info.json (#14274 )	2021-09-12 14:04:56 +10:00
reference_keymap_extras.md	Added mac variant of portuguese keymap extras (#11260 )	2020-12-29 19:40:58 -08:00
serial_driver.md	[Docs] Japanese translation of docs/serial_driver.md (#10014 )	2020-09-03 19:58:03 -07:00
support.md	[Docs] Japanese translation of docs/support.md (#10015 )	2020-09-03 18:50:53 -07:00
syllabus.md	Update Japanese document (#14767 )	2021-10-09 21:03:17 +01:00
tap_hold.md	[Docs] update Japanese translation of tap_hold.md (#12820 )	2021-06-18 15:13:04 +09:00
translating.md	[Docs] Japanese translation of docs/translating.md (#10018 )	2020-09-04 03:28:53 +09:00
understanding_qmk.md	Merge remote-tracking branch 'origin/master' into develop	2021-10-09 20:04:35 +00:00

README.md

Quantum Mechanical Keyboard Firmware

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

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

始めましょう

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

基本: QMK Configurator
- ドロップダウンからあなたのキーボードを選択し、キーボードをプログラムします。
- 見ることができる紹介ビデオがあります。
- 読むことができる概要ドキュメントがあります。
発展: ソースを使用します
- より強力ですが、使うのはより困難です。

自分用にアレンジします

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

手助けが必要ですか？

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

貢献する

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

フォーラムやチャットルームで人々を支援します:
- /r/olkb
- Discord サーバ
下にある「Edit This Page」をクリックしてドキュメントに貢献します
ドキュメントをあなたの言語に翻訳します
バグを報告します
プルリクエストを開きます

README.md Unescape Escape