@@ -57,47 +57,71 @@ GitHub Sponsorsをご利用ください。
5757
5858コントリビュート歓迎です!!
5959
60- ### 推奨環境
60+ ### 必要な環境
6161* macOS 15+
6262* Xcode 26.1+
63- * Git LFS導入済み
64- * SwiftLint導入済み
63+ * Git LFS(必須。Hugging Face上のsubmoduleがLFSを利用しているため、未導入だとモデル重みが取得できません)
64+ * SwiftLint
65+
66+ ``` bash
67+ brew install git-lfs swiftlint
68+ git lfs install
69+ ```
6570
6671### 開発版のビルド・デバッグ
6772
68- まず、想定環境が整っていることを確認してください。 git-lfs のない状態では正しく clone できません。
73+ #### 1. クローン
6974
70- cloneする際には ` --recursive ` をつけてサブモジュールまでローカルに落としてください 。
75+ submoduleにzenzのgguf重みと言語モデル( ` .marisa ` )が含まれるため、 ` --recursive ` と Git LFS の有効化が必須です 。
7176
7277``` bash
78+ git lfs install # 未実行の場合のみ
7379git clone https://github.com/azooKey/azooKey-Desktop --recursive
80+ cd azooKey-Desktop
7481```
7582
76- 以下のスクリプトを用いて最新のコードをビルドしてください。 ` .pkg ` によるインストールと同等になります。その後、上記の手順を行ってください。また、submoduleが更新されている場合は ` git submodule update --init ` を行ってください 。
83+ 既にcloneしていてsubmoduleやLFSが揃っていない場合は以下を実行してください 。
7784
7885``` bash
79- # submoduleを更新
8086git submodule update --init
87+ git -C azooKeyMac/Resources/zenz-v3.1-small-gguf lfs pull
88+ git -C azooKeyMac/Resources/base_n5_lm lfs pull
89+ ```
90+
91+ 重みファイルが正しく取得できているか、サイズで確認できます(数十MB以上あればLFSの実体、134B程度ならポインタのままです)。
92+
93+ ``` bash
94+ ls -lh azooKeyMac/Resources/zenz-v3.1-small-gguf/ggml-model-Q5_K_M.gguf
95+ ```
96+
97+ #### 2. 署名の設定(初回のみ)
98+
99+ ` install.sh ` はアーカイブビルドを行うため、Xcode上で署名設定が通っている必要があります。Apple Developer Programに加入していない場合は、Personal Teamでの署名に切り替えてください。
100+
101+ * ` azooKeyMac.xcodeproj ` を Xcode で開く
102+ * azooKeyMac ターゲット → Signing & Capabilities で Team を自身の Personal Team に変更
103+ * リポジトリ内のバンドルID(` dev.ensan.inputmethod.azooKeyMac ` など)を、自身の所有するプレフィックスに一括置換(例: ` dev.yourname.inputmethod.azooKeyMac ` )
81104
82- # ビルド&インストール
105+ #### 3. ビルド&インストール
106+
107+ ``` bash
83108./install.sh
84109```
85110
111+ ` .pkg ` によるインストールと同等の状態になります。その後、上記の「リリース版インストール」の手順(ログアウト→入力ソース追加)を行ってください。
112+
86113開発中はazooKeyのプロセスをkillすることで最新版を反映することが出来ます。また、必要に応じて入力ソースからazooKeyを削除して再度追加する、macOSからログアウトして再ログインするなど、リセットが必要になる場合があります。
87114
88115### 開発時のトラブルシューティング
89116
90117` install.sh ` でビルドが成功しない場合、以下をご確認ください。
91118
92- * XcodeのGUI上で「Team ID」を変更する必要がある場合があります
93- * ` azooKeyMac.xcodeproj ` を Xcode で開く
94- * azooKeyMac -> Signing & Capabilities から、 Team を Personal Team に変更する
95- * リポジトリ内に存在する全てのバンドルID文字列を、適当な文字列に置換 (ex: ` dev.ensan.inputmethod.azooKeyMac ` -> ` dev.yourname.inputmethod.azooKeyMac ` )
119+ * 署名エラーで失敗する場合は、上記「署名の設定」が完了しているかを確認してください(Team変更とバンドルID置換の両方が必要です)
96120* 「Packages are not supported when using legacy build locations, but the current project has them enabled.」と表示される場合は[ https://qiita.com/glassmonkey/items/3e8203900b516878ff2c ] ( https://qiita.com/glassmonkey/items/3e8203900b516878ff2c ) を参考に、Xcodeの設定をご確認ください
97121* Xcode 26.0ではビルドできない可能性があります。Xcode 16系または26.1以降をご利用ください。
98122
99123変換精度がリリース版に比べて悪いと感じた場合、以下をご確認ください。
100- * Git LFSが導入されていない環境では、重みファイルがローカル環境に落とせていない場合があります。` azooKey-Desktop/ azooKeyMac/Resources/zenz-v3-small-gguf/ggml-model-Q5_K_M.gguf` が70MB程度のファイルとなっているかを確認してください
124+ * Git LFSが導入されていない環境では、重みファイルがローカル環境に落とせていない場合があります。` azooKeyMac/Resources/zenz-v3.1 -small-gguf/ggml-model-Q5_K_M.gguf ` が数十MB以上あるかを確認し、ポインタのままであれば ` git -C azooKeyMac/Resources/zenz-v3.1-small-gguf lfs pull ` を実行してください
101125
102126### pkgファイルの作成
103127` pkgbuild.sh ` によって配布用のdmgファイルを作成できます。` build/azooKeyMac.app ` としてDeveloper IDで署名済みの.appを配置してください。
0 commit comments