aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi ISHII <2170248+mtei@users.noreply.github.com>2020-06-28 20:27:06 +0900
committerGitHub <noreply@github.com>2020-06-28 20:27:06 +0900
commite184da91a662b01eb824329087156bd2507bfad6 (patch)
tree57bbf71b9411dbd719e0cce511d964b6078c75b5
parentd36d5ecfad3ea32c11fbf4a251cea7e25caafc28 (diff)
downloadqmk_firmware-e184da91a662b01eb824329087156bd2507bfad6.tar.gz
qmk_firmware-e184da91a662b01eb824329087156bd2507bfad6.zip
[Update] Japanese translation of docs/cli.md and docs/cli_commands.md (#9536)
* update docs/ja/cli.md * update docs/ja/cli_commands.md * Update docs/ja/cli.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update docs/ja/cli_commands.md Co-authored-by: shela <shelaf@users.noreply.github.com>
-rw-r--r--docs/ja/cli.md15
-rw-r--r--docs/ja/cli_commands.md160
2 files changed, 106 insertions, 69 deletions
diff --git a/docs/ja/cli.md b/docs/ja/cli.md
index dc6dddc41..9e8169a84 100644
--- a/docs/ja/cli.md
+++ b/docs/ja/cli.md
@@ -1,8 +1,8 @@
1# QMK CLI :id=qmk-cli 1# QMK CLI :id=qmk-cli
2 2
3<!--- 3<!---
4 original document: 0.8.58:docs/cli.md 4 original document: 0.9.19:docs/cli.md
5 git diff 0.8.58 HEAD -- docs/cli.md | cat 5 git diff 0.9.19 HEAD -- docs/cli.md | cat
6--> 6-->
7 7
8## 概要 :id=overview 8## 概要 :id=overview
@@ -11,25 +11,24 @@ QMK CLI を使用すると QMK キーボードの構築と作業が簡単にな
11 11
12### 必要事項 :id=requirements 12### 必要事項 :id=requirements
13 13
14CLI は Python 3.5 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) に列挙されているパッケージもインストールする必要があります。これらは QMK CLI をインストールするときに自動的にインストールされます。 14QMK は Python 3.6 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) に列挙されているパッケージもインストールする必要があります。これらは QMK CLI をインストールするときに自動的にインストールされます。
15 15
16### Homebrew を使ったインストール (macOS、いくつかの Linux) :id=install-using-homebrew 16### Homebrew を使ったインストール (macOS、いくつかの Linux) :id=install-using-homebrew
17 17
18[Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます: 18[Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます:
19 19
20``` 20```
21brew tap qmk/qmk 21brew install qmk/qmk/qmk
22brew install qmk
23export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します 22export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します
24qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします 23qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
25``` 24```
26 25
27### easy_install あるいは pip を使ってインストール :id=install-using-easy_install-or-pip 26### pip を使ってインストール :id=install-using-easy_install-or-pip
28 27
29上のリストにあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.5 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします: 28上で列挙した中にあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.6 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします:
30 29
31``` 30```
32pip3 install qmk 31python3 -m pip install qmk
33export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します 32export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します
34qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします 33qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
35``` 34```
diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md
index 013689e5e..81cb03cfe 100644
--- a/docs/ja/cli_commands.md
+++ b/docs/ja/cli_commands.md
@@ -1,48 +1,18 @@
1# QMK CLI コマンド 1# QMK CLI コマンド
2 2
3<!--- 3<!---
4 original document: 0.8.58:docs/cli.md 4 original document: 0.9.19:docs/cli_command.md
5 git diff 0.8.58 HEAD -- docs/cli.md | cat 5 git diff 0.9.19 HEAD -- docs/cli_command.md | cat
6--> 6-->
7 7
8# CLI コマンド 8# ユーザー用コマンド
9
10## `qmk cformat`
11
12このコマンドは clang-format を使って C コードを整形します。
13
14引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。
15
16`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。
17
18**指定したファイルに対する使い方**:
19
20```
21qmk cformat [file1] [file2] [...] [fileN]
22```
23
24**全てのコアファイルに対する使い方**:
25
26```
27qmk cformat -a
28```
29
30**origin/master で変更されたファイルのみに対する使い方**:
31
32```
33qmk cformat
34```
35
36**branch_name で変更されたファイルのみに対する使い方**:
37
38```
39qmk cformat -b branch_name
40```
41 9
42## `qmk compile` 10## `qmk compile`
43 11
44このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。 12このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。
45 13
14このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
15
46**Configurator Exports での使い方**: 16**Configurator Exports での使い方**:
47 17
48``` 18```
@@ -113,6 +83,8 @@ $ qmk compile -kb dz60
113このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。 83このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
114違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、[ファームウェアを書き込む](ja/flashing.md)を見てください。 84違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、[ファームウェアを書き込む](ja/flashing.md)を見てください。
115 85
86このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
87
116**Configurator Exports での使い方**: 88**Configurator Exports での使い方**:
117 89
118``` 90```
@@ -141,16 +113,6 @@ qmk flash -b
141qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] 113qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
142``` 114```
143 115
144## `qmk docs`
145
146このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
147
148**使用法**:
149
150```
151qmk docs [-p PORT]
152```
153
154## `qmk doctor` 116## `qmk doctor`
155 117
156このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。 118このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。
@@ -175,36 +137,40 @@ qmk doctor [-y] [-n]
175 137
176 qmk doctor -n 138 qmk doctor -n
177 139
178## `qmk json2c` 140## `qmk info`
179 141
180QMK Configurator からエクスポートしたものから keymap.c を生成します。 142QMK のキーボードやキーマップに関する情報を表示します。キーボードに関する情報を取得したり、レイアウトを表示したり、基礎となるキーマトリックスを表示したり、JSON キーマップをきれいに印刷したりするのに使用できます。
181 143
182**使用法**: 144**使用法**:
183 145
184``` 146```
185qmk json2c [-o OUTPUT] filename 147qmk info [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
186``` 148```
187 149
188## `qmk kle2json` 150このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
189 151
190このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。 152**例**:
191 153
192**使用**: 154キーボードの基情報を表示する:
193 155
194``` 156 qmk info -kb planck/rev5
195qmk kle2json [-f] <filename>
196```
197 157
198****: 158キーボードのマトリクスを表示す:
199 159
200``` 160 qmk info -kb ergodox_ez -m
201$ qmk kle2json kle.txt 161
202☒ File info.json already exists, use -f or --force to overwrite. 162キーボードの JSON キーマップを表示する:
203``` 163
164 qmk info -kb clueboard/california -km default
165
166## `qmk json2c`
167
168QMK Configurator からエクスポートしたものから keymap.c を生成します。
169
170**使用法**:
204 171
205``` 172```
206$ qmk kle2json -f kle.txt -f 173qmk json2c [-o OUTPUT] filename
207Ψ Wrote out to info.json
208``` 174```
209 175
210## `qmk list-keyboards` 176## `qmk list-keyboards`
@@ -221,6 +187,8 @@ qmk list-keyboards
221 187
222このコマンドは指定されたキーボード(とリビジョン)の全てのキーマップを列挙します。 188このコマンドは指定されたキーボード(とリビジョン)の全てのキーマップを列挙します。
223 189
190このコマンドはディレクトリを認識します。キーボードのディレクトリにいる場合、自動的に KEYBOARD を入力します。
191
224**使用法**: 192**使用法**:
225 193
226``` 194```
@@ -231,12 +199,82 @@ qmk list-keymaps -kb planck/ez
231 199
232このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。 200このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。
233 201
202このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
203
234**使用法**: 204**使用法**:
235 205
236``` 206```
237qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] 207qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
238``` 208```
239 209
210---
211
212# 開発者用コマンド
213
214## `qmk cformat`
215
216このコマンドは clang-format を使って C コードを整形します。
217
218引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。
219
220`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。
221
222**指定したファイルに対する使い方**:
223
224```
225qmk cformat [file1] [file2] [...] [fileN]
226```
227
228**全てのコアファイルに対する使い方**:
229
230```
231qmk cformat -a
232```
233
234**origin/master で変更されたファイルのみに対する使い方**:
235
236```
237qmk cformat
238```
239
240**branch_name で変更されたファイルのみに対する使い方**:
241
242```
243qmk cformat -b branch_name
244```
245
246## `qmk docs`
247
248このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
249
250**使用法**:
251
252```
253qmk docs [-p PORT]
254```
255
256## `qmk kle2json`
257
258このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
259
260**使用法**:
261
262```
263qmk kle2json [-f] <filename>
264```
265
266**例**:
267
268```
269$ qmk kle2json kle.txt
270☒ File info.json already exists, use -f or --force to overwrite.
271```
272
273```
274$ qmk kle2json -f kle.txt -f
275Ψ Wrote out to info.json
276```
277
240## `qmk pyformat` 278## `qmk pyformat`
241 279
242このコマンドは `qmk_firmware` 内の python コードを整形します。 280このコマンドは `qmk_firmware` 内の python コードを整形します。