Skip to content

Commit

Permalink
doc: 补充 readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xnmeet committed Jan 18, 2025
1 parent 0f14402 commit 84be11d
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 8 deletions.
10 changes: 9 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,12 @@ jobs:
files: |
voi-*.bobplugin
appcast.json
generate_release_notes: true
generate_release_notes: true

- name: Commit and Push appcast.json
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add appcast.json
git commit -m "chore: update appcast.json for version ${{ steps.get_latest_tag.outputs.version }}"
git push
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 xnmeet

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,32 @@
# Bob Kokoro TTS Plugin

一个基于 [Bob](https://bobtranslate.com/) 的文本转语音插件,使用 Kokoro 本地部署模型作为语音合成服务。
<div align="center">
<img src="bob-plugin/src/icon.png" width="200" height="200" alt="Plugin Icon">
</div>

## 项目结构
<p align="center">
一个基于 <a href="https://bobtranslate.com/">Bob</a> 的文本转语音插件,使用 Kokoro 本地部署模型作为语音合成服务。
</p>

<p align="center">
<a href="https://github.com/xnmeet/voi/releases/latest">
<img src="https://img.shields.io/github/v/release/xnmeet/voi?include_prereleases&style=flat-square" alt="Version">
</a>
<a href="LICENSE">
<img src="https://img.shields.io/github/license/xnmeet/voi?style=flat-square" alt="MIT License">
</a>
</p>

## 📦 项目结构

本项目包含两个主要部分:

1. **Bob 插件** (`bob-plugin/`): Bob 的文本转语音插件
2. **TTS 服务器** (`server/`): Kokoro TTS 本地服务器

## 快速开始
## 🚀 快速开始

### 1. 部署 TTS 服务器
### 1️⃣ 部署 TTS 服务器

首先下载必需的模型文件:

Expand All @@ -37,21 +52,28 @@ docker run -p 8000:8000 kokoro-tts-conda

详细说明请参考 [服务器文档](server/README.md)

### 2. 安装 Bob 插件
### 2️⃣ 安装 Bob 插件

1. 下载最新版本的插件([Releases](https://github.com/xnmeet/voi/releases/latest)
2. 安装 `.bobplugin` 文件到 Bob 中
3. 在 Bob 的偏好设置中配置服务器地址(例如:`http://localhost:8000/text-to-speech`

详细说明请参考 [插件文档](bob-plugin/README.md)

## 问题反馈
## 🙏 致谢

本项目使用了以下开源项目:

- [kokoro-onnx](https://github.com/thewh1teagle/kokoro-onnx) - Kokoro TTS 的 ONNX 运行时实现
- [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) - Kokoro TTS 模型

## ❓ 问题反馈

如果您在使用过程中遇到任何问题,请通过以下方式反馈:

1. 在 GitHub 上提交 Issue
2. 发送邮件至 [email protected]

## 许可证
## 📄 许可证

[MIT License](LICENSE)
9 changes: 9 additions & 0 deletions server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

基于 Kokoro 模型的本地部署 TTS 服务器。

## 开源项目依赖

本项目基于以下开源项目:

1. [kokoro-onnx](https://github.com/thewh1teagle/kokoro-onnx) - Kokoro TTS 的 ONNX 运行时实现
2. [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) - Kokoro TTS 模型

感谢这些优秀的开源项目的贡献!

## 系统要求

- Python 3.8+
Expand Down

0 comments on commit 84be11d

Please sign in to comment.