Skip to content

Commit 1e63983

Browse files
committed
feat: add Chinese README and update English README links
1 parent 1d66ef3 commit 1e63983

3 files changed

Lines changed: 78 additions & 101 deletions

File tree

README-en.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

README-zh.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
[English](./README.md) | 简体中文
2+
3+
<h1 align="center">
4+
<img src=".github/assets/images/babel-duck-logo.png" alt="BabelDuck Logo" height="40"/>
5+
BabelDuck
6+
</h1>
7+
8+
<br/>
9+
10+
<p align="center">
11+
<a href="https://duck.orenoid.com/">Web 版</a>
12+
</p>
13+
14+
<div align="center">
15+
<p align="center"> <img width="900" alt="BabelDuck Grammar Check" src=".github/assets/images/README-zh-grammar-check.png"> </p>
16+
</div>
17+
18+
<br/>
19+
20+
### 📖 介绍
21+
22+
BabelDuck 是一个面向各水平层次语言学习者的高度可定制化 AI 口语对话练习应用,并对初学者更友好,旨在将口语表达练习的门槛与心智负担降至最低。
23+
24+
### ✨ 主要功能
25+
26+
- 支持多对话管理、自定义系统提示词、流式响应等常见 AI 对话功能
27+
- 可在不影响当前对话的前提下,向 AI 寻求语法、翻译或表达润色等建议,并提供可定制化的快捷指令
28+
- 在对 AI 提供的建议有疑问时,可开启子对话进一步讨论,讨论结束后可无缝返回原对话
29+
- 支持语音输入与语音输出,集成了浏览器内置文本转语音 以及 Azure TTS
30+
- 集成多种 LLM AI 服务,支持自定义第三方 API 服务,可无缝切换
31+
- 数据存储于本地,确保用户数据隐私安全
32+
- 支持针对不同对话进行单独的偏好设置
33+
- 提供多语言界面
34+
- 内置使用教程
35+
36+
### 🛠 部署
37+
38+
1. 安装 Docker
39+
2. 克隆仓库到本地
40+
```shell
41+
git clone https://github.com/Orenoid/BabelDuck
42+
```
43+
3.`.env.example` 文件重命名为 `.env`,并填入相关配置
44+
4. 运行 Docker 容器
45+
```shell
46+
docker run -d --name babel-duck --env-file .env -p 9000:9000 orenoid/babel-duck:latest
47+
```
48+
5. 访问 `http://localhost:9000` 查看效果
49+
50+
### 📄 许可证
51+
本项目采用 [LICENSE](https://github.com/Orenoid/BabelDuck/blob/main/LICENSE),详情请参阅 LICENSE 文件。
52+
53+
### 💬 问题反馈
54+
<img src=".github/assets/images/wechat-group-for-feedback.png" alt="WeChat Group QR Code" width="150"/>

README.md

Lines changed: 24 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[English](./README-en.md) | 简体中文
1+
English | [简体中文](./README-zh.md)
22

33
<h1 align="center">
44
<img src=".github/assets/images/babel-duck-logo.png" alt="BabelDuck Logo" height="40"/>
@@ -8,59 +8,45 @@
88
<br/>
99

1010
<p align="center">
11-
<a href="https://duck.orenoid.com/">Web 版</a>
11+
<a href="https://duck.orenoid.com/">Website</a>
1212
</p>
1313

14+
1415
<div align="center">
15-
<p align="center"> <img width="900" alt="BabelDuck Grammar Check" src=".github/assets/images/README-zh-grammar-check.png"> </p>
16+
<p align="center"> <img height="400" alt="BabelDuck Grammar Check" src=".github/assets/images/README-en-grammar-check.png"> </p>
1617
</div>
1718

1819
<br/>
1920

20-
### 📖 介绍
21+
### 📖 Introduction
2122

22-
BabelDuck 是一个面向各水平层次语言学习者的高度可定制化 AI 口语对话练习应用,并对初学者更友好,旨在将口语表达练习的门槛与心智负担降至最低。
23+
BabelDuck is a highly customizable AI conversation practice application designed for language learners of all levels, with a focus on being beginner-friendly and minimizing the barriers and cognitive load of oral expression practice.
2324

24-
### 主要功能
25+
### Key Features
2526

26-
- 支持多对话管理、自定义系统提示词、流式响应等常见 AI 对话功能
27-
- 可在不影响当前对话的前提下,向 AI 寻求语法、翻译或表达润色等建议,并提供可定制化的快捷指令
28-
- 在对 AI 提供的建议有疑问时,可开启子对话进一步讨论,讨论结束后可无缝返回原对话
29-
- 支持语音输入与语音输出,集成了浏览器内置文本转语音 以及 Azure TTS
30-
- 集成多种 LLM AI 服务,支持自定义第三方 API 服务,可无缝切换
31-
- 数据存储于本地,确保用户数据隐私安全
32-
- 支持针对不同对话进行单独的偏好设置
33-
- 提供多语言界面
34-
- 内置使用教程
27+
- Supports common AI chat features including multiple conversation management, custom system prompts, and streaming responses
28+
- Seek grammar, translation, or expression refinement suggestions from AI without interrupting the current conversation, with customizable quick commands
29+
- When you have questions about AI suggestions, you can start a sub-conversation for further discussion and seamlessly return to the original conversation afterward
30+
- Supports voice input and response
31+
- Integrates multiple LLM AI services with seamless switching
32+
- Data stored locally to ensure user data privacy and security
33+
- Supports individual preference settings for different conversations
34+
- Provides multilingual interface
35+
- Built-in tutorials
3536

36-
### 🛠 部署
37+
### 🛠 Deployment
3738

38-
1. 安装 Docker
39-
2. 克隆仓库到本地
39+
1. Install Docker
40+
2. Clone the repository
4041
```shell
4142
git clone https://github.com/Orenoid/BabelDuck
4243
```
43-
3. `.env.example` 文件重命名为 `.env`,并填入相关配置
44-
4. 运行 Docker 容器
44+
3. Rename `.env.example` to `.env` and fill in the configurations
45+
4. Run Docker container
4546
```shell
4647
docker run -d --name babel-duck --env-file .env -p 9000:9000 orenoid/babel-duck:latest
4748
```
48-
5. 访问 `http://localhost:9000` 查看效果
49-
50-
### 🎯 未来规划
51-
52-
- [ ] 对话模板
53-
- [ ] 复述练习模式
54-
- [ ] 移动端适配
55-
- [ ] 语音回放
56-
- [ ] 支持多模态语音
57-
- [ ] 接入更多 LLM/TTS/STT 服务
58-
- [ ] 实时语音模式
59-
- [ ] 更多指令类型
60-
- [ ] 插件系统
61-
62-
### 📄 许可证
63-
本项目采用 [LICENSE](https://github.com/Orenoid/BabelDuck/blob/main/LICENSE),详情请参阅 LICENSE 文件。
49+
5. Visit `http://localhost:9000` to see it in action
6450

65-
### 💬 问题反馈
66-
<img src=".github/assets/images/wechat-group-for-feedback.png" alt="WeChat Group QR Code" width="150"/>
51+
### 📄 License
52+
This project is licensed under the [LICENSE](https://github.com/Orenoid/BabelDuck/blob/main/LICENSE). See the LICENSE file for details.

0 commit comments

Comments
 (0)