diff --git a/README.md b/README.md index 5f8af7f8f..05156c888 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,37 @@ コアは [VOICEVOX CORE](https://github.com/VOICEVOX/voicevox_core/) 、 全体構成は [こちら](https://github.com/VOICEVOX/voicevox/blob/main/docs/%E5%85%A8%E4%BD%93%E6%A7%8B%E6%88%90.md) に詳細があります。) +## 目次 +利用目的に合わせたガイドを以下から確認できます。 + +- [ユーザーガイド](#ユーザーガイド): 音声合成をしたい方向け +- [開発者・貢献者向けガイド](#開発者貢献者向けガイド): コードを利用したい、ENGINEへコントリビュートしたい方向け +- [マルチエンジン機能に関して](#マルチエンジン機能に関して): オリジナルの VOICEVOX 準拠エンジンを作成したい方向け + ## ユーザーガイド +VOICEVOX ENGINE は HTTP API を介した音声合成・歌声合成を提供します。 +本ガイドではユーザーによるエンジンの導入・設定・利用の方法を案内しています。 + +本ガイドは次の項目から構成されています。 + +- [ダウンロード](#ダウンロード) +- [API ドキュメント](#api-ドキュメント) +- [Docker イメージ](#docker-イメージ) +- [HTTP リクエストで音声合成するサンプルコード](#http-リクエストで音声合成するサンプルコード) +- [音声を調整するサンプルコード](#音声を調整するサンプルコード) +- [読み方を AquesTalk 風記法で取得・修正](#読み方を-aquestalk-風記法で取得修正) +- [ユーザー辞書機能について](#ユーザー辞書機能について) +- [プリセット機能について](#プリセット機能について) +- [2 種類のスタイルでモーフィングするサンプルコード](#2-種類のスタイルでモーフィングするサンプルコード) +- [話者の追加情報を取得するサンプルコード](#話者の追加情報を取得するサンプルコード) +- [キャンセル可能な音声合成](#キャンセル可能な音声合成) +- [HTTP リクエストで歌声合成するサンプルコード](#http-リクエストで歌声合成するサンプルコード) +- [CORS 設定](#cors-設定) +- [データを変更する API を無効化する](#データを変更する-api-を無効化する) +- [文字コード](#文字コード) +- [その他の引数](#その他の引数) +- [アップデート](#アップデート) +- [ライセンス](#ライセンス-1) ### ダウンロード @@ -443,6 +473,22 @@ options: エンジンディレクトリ内にあるファイルを全て消去し、新しいものに置き換えてください。 ## 開発者・貢献者向けガイド +VOICEVOX ENGINE OSS は統合された音声合成器・HTTP サーバー・ビルドシステムを提供し、オープンかつ容易なエンジンの改変・検証を可能にしています。 +本ガイドでは開発者・貢献者による環境構築・実行・ビルド・コントリビュート等の方法を案内しています。 + +本ガイドは次の項目から構成されています。 + +- [貢献者の方へ](#貢献者の方へ) +- [環境構築](#環境構築) +- [実行](#実行) +- [ビルド](#ビルド) +- [コードフォーマット](#コードフォーマット) +- [テスト](#テスト) +- [タイポチェック](#タイポチェック) +- [依存関係](#依存関係) +- [API ドキュメントの確認](#api-ドキュメントの確認) +- [事例紹介](#事例紹介) +- [ライセンス](#ライセンス-1) ### 貢献者の方へ @@ -664,14 +710,24 @@ poetry export --without-hashes --with license -o requirements-license.txt - GPL: NG (全関連コードの公開が必要なため) ### マルチエンジン機能に関して +VOICEVOX プロジェクトは ***VOICEVOX API*** を定義し、様々な音声合成システムの相互連携を目指しています。 +本ガイドでは VOICEVOX API の仕組み・連携方法等を案内しています。 + +本ガイドは次の項目から構成されています。 + +- [VOICEVOX API・マルチエンジンとは](#VOICEVOX-APIマルチエンジンとは) +- [マルチエンジン機能の仕組み](#マルチエンジン機能の仕組み) +- [マルチエンジン機能への対応方法](#マルチエンジン機能への対応方法) +- [マルチエンジン機能対応エンジンの配布方法](#マルチエンジン機能対応エンジンの配布方法) +
+ +#### VOICEVOX API・マルチエンジンとは VOICEVOX エディターでは、複数のエンジンを同時に起動することができます。 この機能を利用することで、自作の音声合成エンジンや既存の音声合成エンジンを VOICEVOX エディター上で動かすことが可能です。 -
- #### マルチエンジン機能の仕組み VOICEVOX API に準拠した複数のエンジンの Web API をポートを分けて起動し、統一的に扱うことでマルチエンジン機能を実現しています。