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