diff options
| -rw-r--r-- | docs/ja/cli.md | 71 | ||||
| -rw-r--r-- | docs/ja/config_options.md | 9 |
2 files changed, 72 insertions, 8 deletions
diff --git a/docs/ja/cli.md b/docs/ja/cli.md index ef3752873..a83ccdf37 100644 --- a/docs/ja/cli.md +++ b/docs/ja/cli.md | |||
| @@ -1,8 +1,8 @@ | |||
| 1 | # QMK CLI | 1 | # QMK CLI |
| 2 | 2 | ||
| 3 | <!--- | 3 | <!--- |
| 4 | original document: d598f01cb:docs/cli.md | 4 | original document: 2fe288d01:docs/cli.md |
| 5 | git diff d598f01cb HEAD -- docs/cli.md | cat | 5 | git diff 2fe288d01 HEAD -- docs/cli.md | cat |
| 6 | --> | 6 | --> |
| 7 | 7 | ||
| 8 | このページは QMK CLI のセットアップと使用方法について説明します。 | 8 | このページは QMK CLI のセットアップと使用方法について説明します。 |
| @@ -86,7 +86,7 @@ qmk cformat [file1] [file2] [...] [fileN] | |||
| 86 | 86 | ||
| 87 | ## `qmk compile` | 87 | ## `qmk compile` |
| 88 | 88 | ||
| 89 | このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルすることができます。 | 89 | このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。 |
| 90 | 90 | ||
| 91 | **Configurator Exports での使い方**: | 91 | **Configurator Exports での使い方**: |
| 92 | 92 | ||
| @@ -100,6 +100,53 @@ qmk compile <configuratorExport.json> | |||
| 100 | qmk compile -kb <keyboard_name> -km <keymap_name> | 100 | qmk compile -kb <keyboard_name> -km <keymap_name> |
| 101 | ``` | 101 | ``` |
| 102 | 102 | ||
| 103 | **キーボードディレクトリでの使い方**: | ||
| 104 | |||
| 105 | default キーマップのあるキーボードディレクトリ、キーボードのキーマップディレクトリ、`--keymap <keymap_name>` で与えられるキーマップディレクトリにいなければなりません。 | ||
| 106 | ``` | ||
| 107 | qmk compile | ||
| 108 | ``` | ||
| 109 | |||
| 110 | **例**: | ||
| 111 | ``` | ||
| 112 | $ qmk config compile.keymap=default | ||
| 113 | $ cd ~/qmk_firmware/keyboards/planck/rev6 | ||
| 114 | $ qmk compile | ||
| 115 | Ψ Compiling keymap with make planck/rev6:default | ||
| 116 | ... | ||
| 117 | ``` | ||
| 118 | あるいはオプションのキーマップ引数を指定して | ||
| 119 | |||
| 120 | ``` | ||
| 121 | $ cd ~/qmk_firmware/keyboards/clueboard/66/rev4 | ||
| 122 | $ qmk compile -km 66_iso | ||
| 123 | Ψ Compiling keymap with make clueboard/66/rev4:66_iso | ||
| 124 | ... | ||
| 125 | ``` | ||
| 126 | あるいはキーマップディレクトリで | ||
| 127 | |||
| 128 | ``` | ||
| 129 | $ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak | ||
| 130 | $ qmk compile | ||
| 131 | Ψ Compiling keymap with make make gh60/satan:colemak | ||
| 132 | ... | ||
| 133 | ``` | ||
| 134 | |||
| 135 | **レイアウトディレクトリでの使い方**: | ||
| 136 | |||
| 137 | `qmk_firmware/layouts/` 以下のキーマップディレクトリにいなければなりません。 | ||
| 138 | ``` | ||
| 139 | qmk compile -kb <keyboard_name> | ||
| 140 | ``` | ||
| 141 | |||
| 142 | **例**: | ||
| 143 | ``` | ||
| 144 | $ cd ~/qmk_firmware/layouts/community/60_ansi/mechmerlin-ansi | ||
| 145 | $ qmk compile -kb dz60 | ||
| 146 | Ψ Compiling keymap with make dz60:mechmerlin-ansi | ||
| 147 | ... | ||
| 148 | ``` | ||
| 149 | |||
| 103 | ## `qmk flash` | 150 | ## `qmk flash` |
| 104 | 151 | ||
| 105 | このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。 | 152 | このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。 |
| @@ -146,14 +193,28 @@ qmk docs [-p PORT] | |||
| 146 | 193 | ||
| 147 | ## `qmk doctor` | 194 | ## `qmk doctor` |
| 148 | 195 | ||
| 149 | このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。 | 196 | このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。 |
| 150 | 197 | ||
| 151 | **使用法**: | 198 | **使用法**: |
| 152 | 199 | ||
| 153 | ``` | 200 | ``` |
| 154 | qmk doctor | 201 | qmk doctor [-y] [-n] |
| 155 | ``` | 202 | ``` |
| 156 | 203 | ||
| 204 | **例**: | ||
| 205 | |||
| 206 | 環境に問題がないか確認し、それらを修正するよう促します: | ||
| 207 | |||
| 208 | qmk doctor | ||
| 209 | |||
| 210 | 環境を確認し、見つかった問題を自動的に修正します: | ||
| 211 | |||
| 212 | qmk doctor -y | ||
| 213 | |||
| 214 | 環境を確認し、問題のみをレポートします: | ||
| 215 | |||
| 216 | qmk doctor -n | ||
| 217 | |||
| 157 | ## `qmk json-keymap` | 218 | ## `qmk json-keymap` |
| 158 | 219 | ||
| 159 | QMK Configurator からエクスポートしたものから keymap.c を生成します。 | 220 | QMK Configurator からエクスポートしたものから keymap.c を生成します。 |
diff --git a/docs/ja/config_options.md b/docs/ja/config_options.md index ca6ea5479..b994b1982 100644 --- a/docs/ja/config_options.md +++ b/docs/ja/config_options.md | |||
| @@ -1,8 +1,8 @@ | |||
| 1 | # QMK の設定 | 1 | # QMK の設定 |
| 2 | 2 | ||
| 3 | <!--- | 3 | <!--- |
| 4 | original document: 9ff61601e:docs/config_options.md | 4 | original document: 2fe288d01:docs/config_options.md |
| 5 | git diff 9ff61601e HEAD -- docs/config_options.md | cat | 5 | git diff 2fe288d01 HEAD -- docs/config_options.md | cat |
| 6 | --> | 6 | --> |
| 7 | 7 | ||
| 8 | QMK はほぼ無制限に設定可能です。可能なところはいかなるところでも、やりすぎな程、ユーザーがコードサイズを犠牲にしてでも彼らのキーボードをカスタマイズをすることを許しています。ただし、このレベルの柔軟性により設定が困難になります。 | 8 | QMK はほぼ無制限に設定可能です。可能なところはいかなるところでも、やりすぎな程、ユーザーがコードサイズを犠牲にしてでも彼らのキーボードをカスタマイズをすることを許しています。ただし、このレベルの柔軟性により設定が困難になります。 |
| @@ -274,9 +274,12 @@ QMK での全ての利用可能な設定にはデフォルトがあります。 | |||
| 274 | * ARM についてはデフォルトの挙動 | 274 | * ARM についてはデフォルトの挙動 |
| 275 | * AVR Teensy については必須 | 275 | * AVR Teensy については必須 |
| 276 | 276 | ||
| 277 | * `#define SPLIT_USB_TIMEOUT 2500` | 277 | * `#define SPLIT_USB_TIMEOUT 2000` |
| 278 | * `SPLIT_USB_DETECT` を使う時のマスタ/スレーブを検出する場合の最大タイムアウト | 278 | * `SPLIT_USB_DETECT` を使う時のマスタ/スレーブを検出する場合の最大タイムアウト |
| 279 | 279 | ||
| 280 | * `#define SPLIT_USB_TIMEOUT_POLL 10` | ||
| 281 | * `SPLIT_USB_DETECT` を使う時のマスタ/スレーブを検出する場合のポーリング頻度 | ||
| 282 | |||
| 280 | # `rules.mk` ファイル | 283 | # `rules.mk` ファイル |
| 281 | 284 | ||
| 282 | これは、トップレベルの `Makefile` から include される [make](https://www.gnu.org/software/make/manual/make.html) ファイルです。これは特定の機能を有効または無効にするだけでなく、コンパイルする MCU に関する情報を設定するために使われます。 | 285 | これは、トップレベルの `Makefile` から include される [make](https://www.gnu.org/software/make/manual/make.html) ファイルです。これは特定の機能を有効または無効にするだけでなく、コンパイルする MCU に関する情報を設定するために使われます。 |
