From 14c00722c40951ec3e0836bc848225b249130f7e Mon Sep 17 00:00:00 2001 From: Naoki Takahashi Date: Sat, 18 Apr 2026 15:08:29 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=E9=96=8B=E7=99=BA=E7=89=88=E3=81=AE?= =?UTF-8?q?=E3=83=93=E3=83=AB=E3=83=89=E6=89=8B=E9=A0=86=E3=82=92=E5=AE=9F?= =?UTF-8?q?=E6=85=8B=E3=81=AB=E5=90=88=E3=82=8F=E3=81=9B=E3=81=A6=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Git LFSの導入とsubmoduleのLFS取得、および署名設定の変更を install.sh実行前の必須手順として明示。トラブルシューティング 側の重複とstaleなパスも整理。 Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 50 +++++++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b15c7105..e710c7a7 100644 --- a/README.md +++ b/README.md @@ -57,47 +57,71 @@ GitHub Sponsorsをご利用ください。 コントリビュート歓迎です！！ -### 推奨環境 +### 必要な環境 * macOS 15+ * Xcode 26.1+ -* Git LFS導入済み -* SwiftLint導入済み +* Git LFS（必須。Hugging Face上のsubmoduleがLFSを利用しているため、未導入だとモデル重みが取得できません） +* SwiftLint + +```bash +brew install git-lfs swiftlint +git lfs install +``` ### 開発版のビルド・デバッグ -まず、想定環境が整っていることを確認してください。 git-lfs のない状態では正しく clone できません。 +#### 1. クローン -cloneする際には`--recursive`をつけてサブモジュールまでローカルに落としてください。 +submoduleにzenzのgguf重みと言語モデル（`.marisa`）が含まれるため、`--recursive`と Git LFS の有効化が必須です。 ```bash +git lfs install # 未実行の場合のみ git clone https://github.com/azooKey/azooKey-Desktop --recursive +cd azooKey-Desktop ``` -以下のスクリプトを用いて最新のコードをビルドしてください。`.pkg`によるインストールと同等になります。その後、上記の手順を行ってください。また、submoduleが更新されている場合は `git submodule update --init` を行ってください。 +既にcloneしていてsubmoduleやLFSが揃っていない場合は以下を実行してください。 ```bash -# submoduleを更新 git submodule update --init +git -C azooKeyMac/Resources/zenz-v3.1-small-gguf lfs pull +git -C azooKeyMac/Resources/base_n5_lm lfs pull +``` + +重みファイルが正しく取得できているか、サイズで確認できます（数十MB以上あればLFSの実体、134B程度ならポインタのままです）。 + +```bash +ls -lh azooKeyMac/Resources/zenz-v3.1-small-gguf/ggml-model-Q5_K_M.gguf +``` + +#### 2. 署名の設定（初回のみ） + +`install.sh` はアーカイブビルドを行うため、Xcode上で署名設定が通っている必要があります。Apple Developer Programに加入していない場合は、Personal Teamでの署名に切り替えてください。 + +* `azooKeyMac.xcodeproj` を Xcode で開く +* azooKeyMac ターゲット → Signing & Capabilities で Team を自身の Personal Team に変更 +* リポジトリ内のバンドルID（`dev.ensan.inputmethod.azooKeyMac` など）を、自身の所有するプレフィックスに一括置換（例: `dev.yourname.inputmethod.azooKeyMac`） -# ビルド＆インストール +#### 3. ビルド＆インストール + +```bash ./install.sh ``` +`.pkg`によるインストールと同等の状態になります。その後、上記の「リリース版インストール」の手順（ログアウト→入力ソース追加）を行ってください。 + 開発中はazooKeyのプロセスをkillすることで最新版を反映することが出来ます。また、必要に応じて入力ソースからazooKeyを削除して再度追加する、macOSからログアウトして再ログインするなど、リセットが必要になる場合があります。 ### 開発時のトラブルシューティング `install.sh`でビルドが成功しない場合、以下をご確認ください。 -* XcodeのGUI上で「Team ID」を変更する必要がある場合があります - * `azooKeyMac.xcodeproj` を Xcode で開く - * azooKeyMac -> Signing & Capabilities から、 Team を Personal Team に変更する - * リポジトリ内に存在する全てのバンドルID文字列を、適当な文字列に置換 (ex: `dev.ensan.inputmethod.azooKeyMac` -> `dev.yourname.inputmethod.azooKeyMac`) +* 署名エラーで失敗する場合は、上記「署名の設定」が完了しているかを確認してください（Team変更とバンドルID置換の両方が必要です） * 「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の設定をご確認ください * Xcode 26.0ではビルドできない可能性があります。Xcode 16系または26.1以降をご利用ください。 変換精度がリリース版に比べて悪いと感じた場合、以下をご確認ください。 -* Git LFSが導入されていない環境では、重みファイルがローカル環境に落とせていない場合があります。`azooKey-Desktop/azooKeyMac/Resources/zenz-v3-small-gguf/ggml-model-Q5_K_M.gguf`が70MB程度のファイルとなっているかを確認してください +* 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` を実行してください ### pkgファイルの作成 `pkgbuild.sh`によって配布用のdmgファイルを作成できます。`build/azooKeyMac.app` としてDeveloper IDで署名済みの.appを配置してください。