開発ガイドを追加

This commit is contained in:
Miwa / Ensan
2024-03-07 02:10:04 +09:00
parent 4c7bfffd53
commit 440ac57e03
3 changed files with 30 additions and 2 deletions

View File

@ -2,4 +2,7 @@
本ディレクトリはAzooKeyKanaKanjiConverterModuleに関するドキュメントをまとめています。
azooKey本体については[azooKey/docs](https://github.com/ensan-hcl/azooKey/tree/develop/docs/overview.md)をご覧ください。
azooKey本体については[azooKey/docs](https://github.com/ensan-hcl/azooKey/tree/develop/docs/overview.md)をご覧ください。
開発ガイドは[development_guide.md](./development_guide.md)をご覧ください。

23
Docs/development_guide.md Normal file
View File

@ -0,0 +1,23 @@
# 開発ガイド
開発にはSwift 5.9以上が必要です。
開発にはレポジトリをクローンしてください。サブモジュールを含むため、`--recursive`オプションが必要です。
```bash
git clone https://github.com/ensan-hcl/AzooKeyKanaKanjiConverter --recursive
```
## Cliツール
デバッグ用のCliツールとして`anco`コマンドがあります。`install_cli.sh`を実行してインストールしてください。場合によっては、`sudo`が必要です。
```bash
sh install_cli.sh
```
詳しくは[cli.md](./cli.md)をお読みください。
## コントリビュート
コントリビュートは歓迎です!