Skip to content

Commit f2e1431

Browse files
committed
docs: update
1 parent 718538d commit f2e1431

File tree

7 files changed

+104
-1
lines changed

7 files changed

+104
-1
lines changed

README.md

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,106 @@
11
# zmk-config-glove43tb
22

3-
<img src="keymap-drawer/glove43tb.svg" >
3+
- glove43tb用のZMKファームウェア
4+
5+
# Docs
6+
7+
## ZMKファームウェアをビルドしてキーマップを変更する
8+
9+
### 全体の流れ
10+
11+
1. GitHubアカウントを作成する
12+
2. ZMKファームウェアのリポジトリをフォークする
13+
3. GitHub Actionsの有効化
14+
4. KeymapEditorとフォークしたリポジトリを連携する
15+
5. KeymapEditorでキー配列変更してファームウェアをビルドする
16+
6. ファームウェアをキーボードに書き込む
17+
18+
### 1. GitHubアカウントを作成する
19+
20+
- 以下のドキュメントを参考にアカウント作成すること
21+
22+
> 公式ドキュメント:
23+
> https://docs.github.com/ja/get-started/start-your-journey/creating-an-account-on-github
24+
>
25+
> 参考ブログ:
26+
> https://zenn.dev/keison8864/articles/069d9be35b92c2
27+
>
28+
29+
### 2. ZMKファームウェアのリポジトリをフォークする
30+
31+
- 以下のリポジトリをフォークする
32+
- https://github.com/keebkuro/zmk-config-glove43tb
33+
- フォーク手順は以下の記事を参考に実施すること
34+
35+
> 公式ドキュメント:
36+
> https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
37+
>
38+
> 参考ブログ:
39+
> https://www.kagoya.jp/howto/rentalserver/webtrend/githubfork/
40+
>
41+
42+
### 3. GitHub Actionsの有効化
43+
44+
- フォークしたリポジトリの「Actions」タブに移動し、「I understand my workflows, go ahead and enable them」をクリックし、github Actionsを有効化
45+
46+
![01.jpg](docs/images/01.jpg)
47+
48+
### 4. KeymapEditorとフォークしたリポジトリを連携する
49+
50+
- [KeymapEditor](https://nickcoutsos.github.io/keymap-editor/)にアクセス
51+
- `GitHub` を選択
52+
53+
![02.jpg](docs/images/02.jpg)
54+
55+
- 「Login with GitHub」からでログインし、「Authorize Keymap Editor」を選択
56+
- 指示に従い、フォークしたリポジトリにKeymapEditorがアクセスできるように進める
57+
58+
### 5. KeymapEditorでキー配列変更してファームウェアをビルドする
59+
60+
- [KeymapEditor](https://nickcoutsos.github.io/keymap-editor/)上でキーマップが表示されたら、好きにキーマップを編集する
61+
- 画面左上の「Save」を押すと、編集したキーマップが適用されてGitHub Actionsが走り、自動的にビルドが開始します
62+
63+
![03.jpg](docs/images/03.jpg)
64+
65+
- 「Save」の隣に表示される「Latest」をクリックするとGitHubに移動し、ビルドが完了するとファームウェアがダウンロードできるようになります。(ビルドには2~4分かかる場合があります。)
66+
67+
### 6. ファームウェアをキーボードに書き込む
68+
69+
- ダウンロードしたzipファイルを解凍する
70+
71+
![04.jpg](docs/images/04.jpg)
72+
73+
#### 6-1. 右側キーボードにファームウェアを書き込む
74+
75+
- `Reset Button`をダブルクリックしてブートモードに切り替える
76+
77+
![05.jpg](docs/images/05.jpg)
78+
79+
- OLED付近のボタンをダブルクリックするとブートモードに入ります
80+
- ブートモードのときにPCとキーボードをUSB接続すると`XIAO-SENSE`というリムーバルディスクが見えるようになります
81+
82+
![06.jpg](docs/images/06.jpg)
83+
84+
- `XIAO-SENSE``glove43tb_R-seeeduino_xiao_ble-zmk.uf2`ファイルをドラッグアンドドロップしてください
85+
86+
> 補足:
87+
> うまく動作しないときは、`settings_reset-seeeduino_xiao_ble-zmk.uf2`を先に書き込んでリセットしてから、上述のファームウェア書き込みを実施すると解消できます
88+
>
89+
90+
#### 6-2. 左側キーボードにファームウェアを書き込む
91+
92+
- 右側キーボードと同じ手順で実施可能です
93+
- 書き込むファームウェアは左側キーボード用のものに読み替えてください(`glove43tb_L-seeeduino_xiao_ble-zmk.uf2`
94+
95+
### 7. 完了
96+
97+
- キーボードのスイッチを入れ直して完了
98+
- キー入力が正常に行えることを確認してください
99+
100+
## ZMK Studioでキーマップを変更する
101+
102+
- TBA
103+
104+
## Keyboard Layout
105+
106+
![glove43tb.svg](keymap-drawer/glove43tb.svg)

docs/images/01.jpg

57.3 KB
Loading

docs/images/02.jpg

65.9 KB
Loading

docs/images/03.jpg

94.7 KB
Loading

docs/images/04.jpg

51.8 KB
Loading

docs/images/05.jpg

72.1 KB
Loading

docs/images/06.jpg

50.3 KB
Loading

0 commit comments

Comments
 (0)