aboutsummaryrefslogtreecommitdiff
path: root/docs/ja/getting_started_docker.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ja/getting_started_docker.md')
-rw-r--r--docs/ja/getting_started_docker.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/ja/getting_started_docker.md b/docs/ja/getting_started_docker.md
new file mode 100644
index 000000000..ceaebb017
--- /dev/null
+++ b/docs/ja/getting_started_docker.md
@@ -0,0 +1,60 @@
1# Docker クイックスタート
2
3<!---
4 original document: 0.12.43:docs/getting_started_docker.md
5 git diff 0.12.43 HEAD -- docs/getting_started_docker.md | cat
6-->
7
8このプロジェクトは、プライマリオペレーティングシステムに大きな変更を加えることなくキーボードの新しいファームウェアを非常に簡単に構築することができる Docker ワークフローを含みます。これは、あなたがプロジェクトをクローンしビルドを実行した時に、他の人とまったく同じ環境と QMK ビルド基盤を持つことも保証します。これにより、人々はあなたが遭遇した問題の解決をより簡単に行えるようになります。
9
10## 必要事項
11
12主な前提条件は動作する `docker` または `podman` がインストールされていることです。
13* [Docker CE](https://docs.docker.com/install/#supported-platforms)
14* [Podman](https://podman.io/getting-started/installation)
15
16## 使い方
17
18(サブモジュールを含む) QMK のレポジトリのローカルコピーを取得する:
19
20```bash
21git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
22cd qmk_firmware
23```
24
25キーマップをビルドするために以下のコマンドを実行します:
26```bash
27util/docker_build.sh <keyboard>:<keymap>
28# 例えば: util/docker_build.sh planck/rev6:default
29```
30
31これは目的のキーボード/キーマップをコンパイルし、結果として書き込み用に `.hex` あるいは `.bin` ファイルを QMK ディレクトリの中に残します。`:keymap` が省略された場合は全てのキーマップが使われます。パラメータの形式は、`make` を使ってビルドする時と同じであることに注意してください。
32
33`target` を指定して Docker から直接キーボードをビルドし、_かつ_ 書き込むためのサポートもあります。
34
35```bash
36util/docker_build.sh keyboard:keymap:target
37# 例えば: util/docker_build.sh planck/rev6:default:flash
38```
39
40スクリプトをパラメータ無しで開始することもできます。この場合、1つずつビルドパラメータを入力するように求められます。これが使いやすいと思うかもしれません:
41
42```bash
43util/docker_build.sh
44# パラメータを入力として読み込みます (空白にすると全てのキーボード/キーマップ)
45```
46
47`RUNTIME` 環境変数にコンテナランタイム名やパスを設定することで、使用したいコンテナランタイムを手動で設定できます。
48デフォルトでは docker や podman は自動的に検出され、podman より docker が優先されます。
49
50```bash
51RUNTIME="podman" util/docker_build.sh keyboard:keymap:target
52```
53
54## FAQ
55
56### なぜ Windows/macOS 上で書き込めないのですか?
57
58Windows と macOS では、実行するために [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/) が必要です。これはセットアップが面倒なので、お勧めではありません: 代わりに [QMK Toolbox](https://github.com/qmk/qmk_toolbox) を使ってください。
59
60!> Docker for Windows は [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) を有効にする必要があります。これは、Windows 7、Windows 8 および **Windows 10 Home** のような Hyper-V を搭載していない Windows のバージョンでは機能しないことを意味します。