diff --git a/Docs/README.md b/Docs/README.md index 5e93692..51b061d 100644 --- a/Docs/README.md +++ b/Docs/README.md @@ -2,4 +2,7 @@ 本ディレクトリはAzooKeyKanaKanjiConverterModuleに関するドキュメントをまとめています。 -azooKey本体については[azooKey/docs](https://github.com/ensan-hcl/azooKey/tree/develop/docs/overview.md)をご覧ください。 \ No newline at end of file +azooKey本体については[azooKey/docs](https://github.com/ensan-hcl/azooKey/tree/develop/docs/overview.md)をご覧ください。 + +開発ガイドは[development_guide.md](./development_guide.md)をご覧ください。 + diff --git a/Docs/development_guide.md b/Docs/development_guide.md new file mode 100644 index 0000000..06e6e9e --- /dev/null +++ b/Docs/development_guide.md @@ -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)をお読みください。 + +## コントリビュート + +コントリビュートは歓迎です! diff --git a/README.md b/README.md index 63f20d6..0369667 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ AzooKeyKanaKanjiConverterは[azooKey](https://github.com/ensan-hcl/azooKey)のために開発したかな漢字変換エンジンです。数行のコードでかな漢字変換をiOS / macOS / visionOSのアプリケーションに組み込むことができます。 ## 動作環境 -iOS 14以降, macOS 11以降, visionOS 1以降, Ubuntu 22.04以降で動作を確認しています +iOS 14以降, macOS 11以降, visionOS 1以降, Ubuntu 22.04以降で動作を確認しています。 + +AzooKeyKanaKanjiConverterの開発については[開発ガイド](Docs/development_guide.md)をご覧ください。 ## KanaKanjiConverterModule かな漢字変換を受け持つモジュールです。