docs: add changelog and development guide links

freedgw · Apr 26, 2023 · dc91f42 · dc91f42
1 parent 5314241
commit dc91f42
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -11,19 +11,19 @@
   <img src="./assets/demo-en.png" alt="SpeechGPT Website Demo" width="900" />
 </p>
 
-## Introduction
+## 🌟 Introduction
 SpeechGPT is a web application that enables you to converse with ChatGPT.</br>
 You can utilize this app to improve your language speaking skills or simply have fun chatting with ChatGPT.
 
-## Features
+## 🚀 Features
 - 📖 **Open source and free**: Anyone can use, modify it without cost.
 - 🔒 **Privacy First**: All data is stored locally.
 - 📱 **Mobile friendly**: Designed to be accessible and usable on mobile devices.
 - 📚 **Support for multiple languages**: Supports over 100 languages.
 - 🎙 **Speech Recognition**: Includes both built-in speech recognition and integration with Azure Speech Services.
 - 🔊 **Speech Synthesis**: Includes built-in speech synthesis, as well as integration with Amazon Polly and Azure Speech Services.
 
-## Screenshots
+## 📸 Screenshots
 <table>
   <tr>
     <td><img src="./assets/screenshots/screenshot-1-en.png" width="360px" alt="Screenshot 1"></td>
@@ -32,7 +32,7 @@ You can utilize this app to improve your language speaking skills or simply have
   </tr>
 </table>
 
-## Tutorial
+## 📖 Tutorial
 1. Set the OpenAI API Key <br/>
     - Go to Settings and navigate to the Chat section.
     - Set the OpenAI API Key.
@@ -47,28 +47,11 @@ You can utilize this app to improve your language speaking skills or simply have
     - Set the AWS Region, AWS Access Key ID, and Secret Access Key (the Access Key should have the AmazonPollyFullAccess policy).
     - If you don't have an AWS Access Key, follow this tutorial on [how to create an IAM user in AWS](https://www.techtarget.com/searchcloudcomputing/tutorial/Step-by-step-guide-on-how-to-create-an-IAM-user-in-AWS).
 
-## Development
-1. Install dependencies.
-```bash
-yarn
-```
-
-2. Start development server.
-```bash
-yarn dev
-```
-
-3. Build for production.
-```bash
-yarn build
-```
-
-Code formatting(Using Prettier).
-```bash
-yarn format
-```
+## 💻 Development Guide and Changelog
+- For more information on setting up your development environment, please see our [Development Guide](./docs/developer-guide.md).
+- To view the project's history of notable changes, please check the [Changelog](./CHANGELOG.md).
 
-## Deployment
+## 🚢 Deployment
 
 ### Deploying with Vercel
 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fhahahumble%2Fspeechgpt&env=VITE_OPENAI_API_KEY,VITE_OPENAI_HOST,VITE_AWS_REGION,VITE_AWS_ACCESS_KEY_ID,VITE_AWS_ACCESS_KEY,VITE_AZURE_REGION,VITE_AZURE_KEY&envDescription=If%20you%20do%20not%20want%20to%20provide%20a%20value%2C%20use%20REPLACE_WITH_YOUR_OWN.&project-name=speechgpt&repository-name=speechgpt)
@@ -99,5 +82,5 @@ docker run -d -p 8080:8080 --name=speechgpt speechgpt
 
 3. Visit `http://localhost:8080/` to access the application.
 
-## License
+## 📄 License
 This project is licensed under the terms of the [MIT license](/LICENSE).
diff --git a/docs/README.zh.md b/docs/README.zh.md
@@ -10,19 +10,19 @@
   <img src="../assets/demo-zh.png" alt="SpeechGPT Website Demo" width="900px" />
 </p>
 
-## 简介
+## 🌟 简介
 SpeechGPT 是一个让你与 ChatGPT 聊天的网站。<br/>
 你可以使用 SpeechGPT 来练习你的口语，或者只是和 ChatGPT 闲聊。
 
-## 特点
+## 🚀 特点
 - 📖 **开源免费**: 任何人都可以免费使用、修改。
 - 🔒 **隐私至上**: 所有数据都存储在本地，保护用户隐私。
 - 📱 **移动端友好**: 具有响应式设计。
 - 📚 **支持多种语言**: 支持超过 100 种语言。
 - 🎙 **语音识别**: 包括浏览器内置的语音识别功能和与 Azure 语音服务的集成。
 - 🔊 **语音合成**: 包括浏览器内置的语音合成功能，以及与 Amazon Polly 和 Azure 语音服务的集成。
 
-## 屏幕截图
+## 📸 屏幕截图
 <table>
   <tr>
     <td><img src="../assets/screenshots/screenshot-1-zh.png" width="360px" alt="Screenshot 1"></td>
@@ -31,7 +31,7 @@ SpeechGPT 是一个让你与 ChatGPT 聊天的网站。<br/>
   </tr>
 </table>
 
-## 教程
+## 📖 教程
 1. 设置 OpenAI API Key <br/>
     - 进入设置，进入对话部分。
     - 设置 OpenAI API Key。
@@ -46,28 +46,11 @@ SpeechGPT 是一个让你与 ChatGPT 聊天的网站。<br/>
     - 设置 AWS 区域、AWS 访问密钥 ID 和密钥访问密钥（访问密钥应具有 AmazonPollyFullAccess 策略）。
     - 如果您没有 AWS Access Key，请按照[如何在 AWS 中创建 IAM 用户的教程](https://www.techtarget.com/searchcloudcomputing/tutorial/Step-by-step-guide-on-how-to-create-an-IAM-user-in-AWS)进行操作。
 
-## 开发
-1. 安装依赖
-```bash
-yarn
-```
-
-2. 启动开发服务器
-```bash
-yarn dev
-```
-
-3. 构建生产环境版本
-```bash
-yarn build
-```
-
-代码格式化（使用 Prettier）
-```bash
-yarn format
-```
+## 💻 开发指南和更新日志
+如需了解有关设置开发环境的更多信息，请查看我们的[开发指南](./docs/developer-guide.zh.md)。
+若要查看项目的重要更改历史，请查阅[更新日志](./CHANGELOG.md)。
 
-## 部署
+## 🚢 部署
 ### 使用 Vercel 部署
 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fhahahumble%2Fspeechgpt&env=VITE_OPENAI_API_KEY,VITE_OPENAI_HOST,VITE_AWS_REGION,VITE_AWS_ACCESS_KEY_ID,VITE_AWS_ACCESS_KEY,VITE_AZURE_REGION,VITE_AZURE_KEY&envDescription=If%20you%20do%20not%20want%20to%20provide%20a%20value%2C%20use%20REPLACE_WITH_YOUR_OWN.&project-name=speechgpt&repository-name=speechgpt)
 
@@ -97,5 +80,5 @@ docker run -d -p 8080:8080 --name=speechgpt speechgpt
 
 3. 访问 `http://localhost:8080/`
 
-## 许可
+## 📄 许可
 本项目根据 [MIT 许可证](/LICENSE) 的条款进行许可。