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
..
README.md	[Core] [Docs] Remove travis-ci references (#13916 )	2021-08-20 23:31:26 +01:00
_summary.md	[Docs] Update Japanese faq documents (#12842 )	2021-06-24 21:54:54 +09:00
adc_driver.md	…
api_development_environment.md	…
api_development_overview.md	…
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	…
breaking_changes.md	[Core] [Docs] Remove travis-ci references (#13916 )	2021-08-20 23:31:26 +01:00
breaking_changes_instructions.md	…
cli.md	…
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
coding_conventions_c.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
coding_conventions_python.md	…
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	…
configurator_troubleshooting.md	…
contributing.md	Update Japanese document (#14769 )	2021-10-09 21:02:55 +01:00
custom_matrix.md	…
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	…
documentation_templates.md	[Update] Change Original TAGs of Japanese translations (#13396 )	2021-07-01 14:04:38 +09:00
driver_installation_zadig.md	…
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	…
feature_auto_shift.md	…
feature_backlight.md	[Docs] update Japanese translation of feature_backlight.md (#14403 )	2021-09-23 13:02:32 +09:00
feature_bluetooth.md	…
feature_bootmagic.md	Fix some additional bootmagic settings (#13979 )	2021-08-12 13:03:40 -07:00
feature_combo.md	…
feature_command.md	…
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	…
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	…
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	…
feature_key_lock.md	…
feature_layers.md	Move tmk_core/common/<plat> (#13918 )	2021-11-19 10:41:02 -08:00
feature_layouts.md	…
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	…
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	…
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	…
feature_thermal_printer.md	…
feature_unicode.md	…
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	…
flashing.md	…
flashing_bootloadhid.md	…
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	…
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	…
i2c_driver.md	Align ChibiOS I2C defs with other drivers (#14399 )	2021-09-12 15:41:33 +01:00
internals_defines.md	…
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	…
internals_midi_device.md	…
internals_midi_device_setup_process.md	…
internals_midi_util.md	…
internals_send_functions.md	…
internals_sysex_tools.md	…
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.md	…
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
keymap.md	…
mod_tap.md	[Docs] update Japanese translation of mod_tap.md (#13981 )	2021-10-01 17:24:53 +09:00
newbs.md	Update Japanese newbs.md document. (#12835 )	2021-06-13 04:10:23 +09:00
newbs_building_firmware.md	…
newbs_building_firmware_configurator.md	Update Japanese newbs_building_firmware_configurator.md document. (#12836 )	2021-06-08 02:43:21 +09: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	…
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 )	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
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	…
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	…
serial_driver.md	…
support.md	…
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	…
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