diff options
Diffstat (limited to 'docs/ja/newbs_getting_started.md')
-rw-r--r-- | docs/ja/newbs_getting_started.md | 210 |
1 files changed, 210 insertions, 0 deletions
diff --git a/docs/ja/newbs_getting_started.md b/docs/ja/newbs_getting_started.md new file mode 100644 index 000000000..ece64e8d8 --- /dev/null +++ b/docs/ja/newbs_getting_started.md | |||
@@ -0,0 +1,210 @@ | |||
1 | # QMK 環境の構築 | ||
2 | |||
3 | <!--- | ||
4 | grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh | ||
5 | original document: 0.13.20:docs/newbs_getting_started.md | ||
6 | git diff 0.13.20 HEAD -- docs/newbs_getting_started.md | cat | ||
7 | --> | ||
8 | |||
9 | キーマップをビルドする前に、いくつかのソフトウェアをインストールしてビルド環境を構築する必要があります。 | ||
10 | ファームウェアをコンパイルするキーボードの数に関わらず、この作業を一度だけ実行する必要があります。 | ||
11 | |||
12 | ## 1. 前提条件 | ||
13 | |||
14 | 始めるために必要なソフトウェアがいくつかあります。 | ||
15 | |||
16 | * [テキストエディタ](ja/newbs_learn_more_resources.md#text-editor-resources) | ||
17 | * プレーンテキストファイルを編集して保存できるプログラムが必要です。多くの OS に付属するデフォルトのエディタはプレーンテキストファイルを保存しないため、選択したエディタがプレーンテキストファイルを保存することを確認する必要があります。 | ||
18 | * [Toolbox (オプション)](https://github.com/qmk/qmk_toolbox) | ||
19 | * Windows と macOS で使える GUI を備えたプログラムで、カスタムキーボードのプログラミングとデバッグの両方ができます。 | ||
20 | |||
21 | ?> もし、Linux か Unix のコマンドを使ったことがない場合、こちらで基本的な概念や各種コマンドを学んでください。[これらの教材](ja/newbs_learn_more_resources.md#command-line-resources)で QMK を使うのに必要なことを学ぶことができます。 | ||
22 | |||
23 | ## 2. ビルド環境を準備する :id=set-up-your-environment | ||
24 | |||
25 | 私たちは、QMK を可能な限り簡単に構築できるように努力しています。Linux か Unix 環境を用意するだけで、QMK に残りをインストールさせることができます。 | ||
26 | |||
27 | <!-- tabs:start --> | ||
28 | |||
29 | ### ** Windows ** | ||
30 | |||
31 | QMK は、MSYS2、CLI、および必要な全ての依存関係のバンドルを保守しています。また、正しい環境で直接起動するための便利な `QMK MSYS` ターミナルショートカットも提供しています。 | ||
32 | |||
33 | #### 前提条件 | ||
34 | |||
35 | [QMK MSYS](https://msys.qmk.fm/) をインストールする必要があります。最新リリースは[ここ](https://github.com/qmk/qmk_distro_msys/releases/latest)から入手できます。 | ||
36 | |||
37 | または、MSYS2 を手動でインストールしたい場合、次のセクションでプロセスを説明します。 | ||
38 | |||
39 | <details> | ||
40 | <summary>手動インストール</summary> | ||
41 | |||
42 | ?> `QMK MSYS` を使う場合、次のステップは無視してください。 | ||
43 | |||
44 | #### 前提条件 | ||
45 | |||
46 | MSYS2 と Git と Python をインストールする必要があります。https://www.msys2.org のインストール手順に従ってください。 | ||
47 | |||
48 | MSYS2 をインストールしたら、開いている MSYS の全ターミナル画面を閉じて、新しい MinGW 64-bit ターミナル画面を開きます。 | ||
49 | |||
50 | !> **注意:** MinGW 64-bit ターミナルは、インストールが完了した時に開く MSYS ターミナルと*同じではありません*。プロンプトには、「MSYS」ではなく、紫色のテキストで「MINGW64」と表示されます。違いについての詳細は[このページ](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems)を参照してください。 | ||
51 | |||
52 | それから、次のように実行します: | ||
53 | |||
54 | pacman --needed --noconfirm --disable-download-timeout -S git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python3-pip | ||
55 | |||
56 | #### インストール | ||
57 | |||
58 | 次のコマンドを実行して、QMK CLI をインストールします: | ||
59 | |||
60 | python3 -m pip install qmk | ||
61 | |||
62 | </details> | ||
63 | |||
64 | ### ** macOS ** | ||
65 | |||
66 | QMK は CLI と全ての必要な依存関係を自動的にインストールする Homebrew tap と formula を保守しています。 | ||
67 | |||
68 | #### 前提条件 | ||
69 | |||
70 | Homebrew のインストールが必要です。https://brew.sh の手順に従ってください。 | ||
71 | |||
72 | #### インストール | ||
73 | |||
74 | 次のコマンドを実行して、QMK CLI をインストールします: | ||
75 | |||
76 | brew install qmk/qmk/qmk | ||
77 | |||
78 | ### ** Linux/WSL ** | ||
79 | |||
80 | ?> **WSL ユーザーへの注意**: デフォルトでは、インストールプロセスは QMK リポジトリを WSL ホームディレクトリに clone しますが、手動で clone した場合、Windows ファイルシステムではなく、WSL インスタンス内にある(つまり `/mnt` 内にない)ことを確認してください。これは、現在アクセスが[非常に遅い](https://github.com/microsoft/WSL/issues/4197)ためです。 | ||
81 | |||
82 | #### 前提条件 | ||
83 | |||
84 | Git と Python をインストールする必要があります。両方とも既にインストールされている可能性は高いですが、そうでない場合、次のコマンドのいずれかでそれらをインストールできます: | ||
85 | |||
86 | * Debian / Ubuntu / Devuan: `sudo apt install -y git python3-pip` | ||
87 | * Fedora / Red Hat / CentOS: `sudo yum -y install git python3-pip` | ||
88 | * Arch / Manjaro: `sudo pacman --needed --noconfirm -S git python-pip libffi` | ||
89 | * Void: `sudo xbps-install -y git python3-pip` | ||
90 | * Solus: `sudo eopkg -y install git python3` | ||
91 | * Sabayon: `sudo equo install dev-vcs/git dev-python/pip` | ||
92 | * Gentoo: `sudo emerge dev-vcs/git dev-python/pip` | ||
93 | |||
94 | #### インストール | ||
95 | |||
96 | 次のコマンドを実行して、QMK CLI をインストールします: | ||
97 | |||
98 | python3 -m pip install --user qmk | ||
99 | |||
100 | #### コミュニティパッケージ | ||
101 | |||
102 | これらのパッケージはコミュニティメンバーによって保守されているため、最新ではないか、完全には機能しない可能性があります。問題が発生した場合は、それぞれのメンテナに報告してください。 | ||
103 | |||
104 | Arch ベースのディストリビューションでは、公式リポジトリから CLI をインストールできます(注意: 執筆時点では、このパッケージは一部の依存関係をオプションとしてマークしていますが、そうではありません): | ||
105 | |||
106 | sudo pacman -S qmk | ||
107 | |||
108 | AUR から `qmk-git` パッケージを試すこともできます: | ||
109 | |||
110 | yay -S qmk-git | ||
111 | |||
112 | ### ** FreeBSD ** | ||
113 | |||
114 | #### インストール | ||
115 | |||
116 | 次のコマンドを実行して、QMK CLI の FreeBSD パッケージをインストールします: | ||
117 | |||
118 | pkg install -g "py*-qmk" | ||
119 | |||
120 | 注意: インストールの最後に表示された指示に従うことを忘れないでください(再度表示するには、`pkg info -Dg "py*-qmk"` を使ってください)。 | ||
121 | |||
122 | <!-- tabs:end --> | ||
123 | |||
124 | ## 3. QMK の設定を行う :id=set-up-qmk | ||
125 | |||
126 | <!-- tabs:start --> | ||
127 | |||
128 | ### ** Windows ** | ||
129 | |||
130 | QMK のインストール後に、このコマンドで設定できます: | ||
131 | |||
132 | qmk setup | ||
133 | |||
134 | ほとんどの場合、全てのプロンプトに `y` と答えます。 | ||
135 | |||
136 | ### ** macOS ** | ||
137 | |||
138 | QMK のインストール後に、このコマンドで設定できます: | ||
139 | |||
140 | qmk setup | ||
141 | |||
142 | ほとんどの場合、全てのプロンプトに `y` と答えます。 | ||
143 | |||
144 | ### ** Linux/WSL ** | ||
145 | |||
146 | QMK のインストール後に、このコマンドで設定できます: | ||
147 | |||
148 | qmk setup | ||
149 | |||
150 | ほとんどの場合、全てのプロンプトに `y` と答えます。 | ||
151 | |||
152 | ?>**Debian、Ubuntu、それらの派生に関する注意**: | ||
153 | 次のようなエラーが表示される可能性があります: `bash: qmk: command not found`. | ||
154 | これは Debian の Bash 4.4 リリースで導入された[バグ](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839155)で、`$HOME/.local/bin` が PATH から削除されました。このバグは後に Debian や Ubuntu で修正されました。 | ||
155 | 残念なことに、Ubuntu はこのバグを再導入し、[まだ修正していません](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562)。 | ||
156 | 幸い、修正は簡単です。これをあなたのユーザで実行します: `echo 'PATH="$HOME/.local/bin:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc` | ||
157 | |||
158 | ### ** FreeBSD ** | ||
159 | |||
160 | QMK のインストール後に、このコマンドで設定できます: | ||
161 | |||
162 | qmk setup | ||
163 | |||
164 | ほとんどの場合、全てのプロンプトに `y` と答えます。 | ||
165 | |||
166 | <!-- tabs:end --> | ||
167 | |||
168 | ?> qmk ホームフォルダは、セットアップ時に `qmk setup -H <path>` を使って指定し、[cli 構成](ja/cli_configuration.md?id=single-key-example)と変数 `user.qmk_home` を使って変更できます。利用可能な全てのオプションについては、`qmk setup --help` を実行します。 | ||
169 | |||
170 | ?> 既に GitHub の使い方を知っている場合、[これらの手順に従うことをお勧めします](ja/getting_started_github.md)。そして `qmk setup <github_username>/qmk_firmware` を使って個人用の fork から clone します。この一文の意味が分からない場合、このメッセージは無視してかまいません。 | ||
171 | |||
172 | ## 4. ビルド環境の確認 | ||
173 | |||
174 | これで QMK のビルド環境が用意できたので、キーボードのファームウェアをビルドできます。キーボードのデフォルトキーマップをビルドすることから始めます。次の形式のコマンドでビルドできるはずです: | ||
175 | |||
176 | qmk compile -kb <keyboard> -km default | ||
177 | |||
178 | 例えば、Clueboard 66% のファームウェアをビルドする場合、次のようにします: | ||
179 | |||
180 | qmk compile -kb clueboard/66/rev3 -km default | ||
181 | |||
182 | 大量の出力の最後に次のように出力されると完了です: | ||
183 | |||
184 | ``` | ||
185 | Linking: .build/clueboard_66_rev3_default.elf [OK] | ||
186 | Creating load file for flashing: .build/clueboard_66_rev3_default.hex [OK] | ||
187 | Copying clueboard_66_rev3_default.hex to qmk_firmware folder [OK] | ||
188 | Checking file size of clueboard_66_rev3_default.hex [OK] | ||
189 | * The firmware size is fine - 26356/28672 (2316 bytes free) | ||
190 | ``` | ||
191 | |||
192 | ## 5. ビルド環境の設定(オプション) | ||
193 | |||
194 | ビルド環境を設定してデフォルトを設定することで、QMK での作業をあまり面倒くさくないようにすることができます。今からやりましょう! | ||
195 | |||
196 | QMK を初めて使うほとんどの人は、キーボードを1つしか持っていません。`qmk config` コマンドでこのキーボードをデフォルトとして設定できます。例えば、デフォルトのキーボードを `clueboard/66/rev4` に設定するには: | ||
197 | |||
198 | qmk config user.keyboard=clueboard/66/rev4 | ||
199 | |||
200 | デフォルトキーマップ名を設定することもできます。ほとんどの人はここで GitHub ユーザ名を使いますが、そうすることをお勧めします。 | ||
201 | |||
202 | qmk config user.keymap=<github_username> | ||
203 | |||
204 | この後、これらの引数をオフにして、次のようにキーボードをコンパイルできます: | ||
205 | |||
206 | qmk compile | ||
207 | |||
208 | # キーマップの作成 | ||
209 | |||
210 | これであなた専用のキーマップを作成する準備ができました!次は[初めてのファームウェアの構築](ja/newbs_building_firmware.md)で専用のキーマップを作成します。 | ||