Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liou666 committed Apr 15, 2023
1 parent a778ba3 commit 07c7453
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 3 deletions.
52 changes: 49 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
Polyglot是一款桌面端应用程序。基于ChatGPT和Azure人工智能语言模型作为底层服务,使用Vue3+TS技术栈构建,旨在提供一个易于使用的语言练习平台,方便进行多语种的口语练习。

<p align="center">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/a.png">
<img width="" alt="Screenshot: Polyglot App running" src="./screenshot/0.1.0.png">
</p>

## 下载
- **Mac**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.1.1/Polyglot_0.1.1.dmg)
- **Windows**: [点击下载](https://github.com/liou666/polyglot/releases/download/v0.1.1/Polyglot_0.1.1.exe)

## 功能
- [x] 多国语言口语练习 (~~目前内置四个不同国家的AI人物,分别来自美国、日本、韩国和法国。后续将考虑增加更多的语种。~~)(内置了英语,其他语言现在支持自定义)
- [x] 智能语音合成(基于Azure TTS服务)
Expand All @@ -22,7 +26,9 @@ Polyglot是一款桌面端应用程序。基于ChatGPT和Azure人工智能语言
+ 选择喜欢的AI人物进行对话;
+ 与AI人物进行对话练习口语。

## 安装


## 本地启动
```bash
# 1.克隆本仓库;
git clone https://github.com/liou666/polyglot.git
Expand All @@ -33,7 +39,7 @@ pnpm install
# 安装 electron 失败时尝试使用淘宝镜像源安装👇:
# export ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/ && pnpm i

# 3.配置环境变量
# 3. 根据注释提示配置相关的环境变量
mv .env.example .env

# 4. 启动服务
Expand All @@ -43,3 +49,43 @@ pnpm dev

## 贡献
如果您有任何建议或意见,欢迎提出 [Issues](https://github.com/liou666/polyglot/issues)[ Pull Request](https://github.com/liou666/polyglot/pulls)

## 协议
[MIT License](./LICENSE)

## 常见问题

<details>
<summary>1. 我所在的地区有网络限制,怎么正常使用?</summary>

应用支持使用代理,具体代理搭建过程google一下

</details>

<details>
<summary>2. MacOS 提示无法打开“Polyglot”,因为Apple无法检查其是否包含恶意软件。</summary>

这个错误因为 macOS 操作系统中的 Gatekeeper 安全功能阻止了应用程序的运行。
要解决此问题,请按照以下步骤操作:

打开“系统偏好设置”并点击“安全性与隐私”。
在“通用”选项卡中,您将看到一个消息:“Polyglot”已被阻止。单击“仍要打开”。
或者,你可以单击“打开任何方式”以打开你的应用程序。
(可能需要使用管理员权限来打开应用程序。)

如果不想在每次打开应用程序时都执行这些步骤,则可以的应用程序添加到白名单中,以便在不受阻止的情况下运行。要将您的应用程序添加到白名单中,请执行以下操作:

打开终端并输入以下命令:

```sh
xattr -rd com.apple.quarantine /path/to/Polyglot.app
```
其中,/path/to/Polyglot.app 是你的应用程序的完整路径。

运行命令后,应用程序将被添加到白名单中,Gatekeeper 将不再阻止其运行。
</details>


## 讨论与交流

<img width="200" alt="Screenshot: Polyglot App running" src="./screenshot/chat.JPG">
File renamed without changes
File renamed without changes
Binary file added screenshot/chat.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 07c7453

Please sign in to comment.