Skip to content

Commit

Permalink
restructure into quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
cm-ayf committed May 22, 2024
1 parent 1c43a5e commit 1c69935
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@ om-syrinxでは,入力全体を一度に処理するのではなく,順番

実際のテキスト処理と音声合成はそれぞれ「[jpreprocess](https://crates.io/crates/jpreprocess)」と「[jbonsai](https://crates.io/crates/jbonsai)」が担っています.om-syrinxはこれらとNode.jsとのバインディングに加え,スレッド管理,バッファリング,opusへのエンコード機能を提供します.

## インストール
## クイックスタート

### ライブラリ本体
### 準備

以下を実行してください:
```sh
npm install github:discordjs-japan/om-syrinx#v0.3.0
```

### jpreprocess用の辞書

[jpreprocessの最新のリリース](https://github.com/jpreprocess/jpreprocess/releases/latest)から辞書 (`naist-jdic-jpreprocess.tar.gz`) をダウンロードして解凍してください.
npmのプロジェクトがあることを前提とします.

### jbonsai用のモデル
以下の3つの手順を実行してください.
- ライブラリ本体をインストールする:\
`npm install github:discordjs-japan/om-syrinx#v0.3.0`を実行してください.
- jpreprocess用の辞書をダウンロードする:\
[jpreprocessの最新のリリース](https://github.com/jpreprocess/jpreprocess/releases/latest)から辞書 (`naist-jdic-jpreprocess.tar.gz`) をダウンロードし,解凍してください.
- jbonsai用のモデルをダウンロードする:\
htsvoice-tohoku-f01 の`master`ブランチ (<https://github.com/icn-lab/htsvoice-tohoku-f01/archive/refs/heads/master.tar.gz>) をダウンロードし解凍してください.

jbonsaiは,[HTS Engine](https://hts-engine.sourceforge.net)でも用いられる`.htsvoice`モデルを使用して音声を合成します.
ここでは例として,[`htsvoice-tohoku-f01`](https://github.com/icn-lab/htsvoice-tohoku-f01)を使用します.`htsvoice-tohoku-f01`は,4つの`.htsvoice`モデルを含むリポジトリです.他の`.htsvoice`モデルを使用することもできます.
<details>
<summary>jbonsai用のモデルについて</summary>

1. `htsvoice-tohoku-f01``master`ブランチ (<https://github.com/icn-lab/htsvoice-tohoku-f01/archive/refs/heads/master.tar.gz>) をダウンロードしてください.
1. `tar xz`等で展開して,生成される`htsvoice-tohoku-f01-master`フォルダを適切な場所に配置してください.
jbonsaiは,[HTS Engine](https://hts-engine.sourceforge.net)でも用いられる`.htsvoice`モデルを使用して音声を合成します.\
ここでは例として,[htsvoice-tohoku-f01](https://github.com/icn-lab/htsvoice-tohoku-f01) を使用しました.htsvoice-tohoku-f01 は,4つの`.htsvoice`モデルを含むリポジトリです.他の`.htsvoice`モデルを使用することもできます.
</details>

## 使い方
### 使い方

ここでは,`inputText`から`stream`を生成する例を示します.

Expand Down

0 comments on commit 1c69935

Please sign in to comment.