docs: Update README and add development documentation

- Reformatted sections in README.md for better readability.
- Added new development documentation in docs/dev.md to guide setup and installation processes.
- Updated Japanese and Chinese README translations to reference the new development documentation.
This commit is contained in:
kangfenmao 2025-03-14 16:49:51 +08:00
parent 394483c363
commit 4c5b8ee0ee
4 changed files with 117 additions and 150 deletions

View File

@ -54,6 +54,7 @@ Cherry Studio is a desktop client that supports for multiple LLM providers, avai
- 🔌 Mini Program Support - 🔌 Mini Program Support
5. **Enhanced User Experience**: 5. **Enhanced User Experience**:
- 🖥️ Cross-platform Support for Windows, Mac, and Linux - 🖥️ Cross-platform Support for Windows, Mac, and Linux
- 📦 Ready to Use, No Environment Setup Required - 📦 Ready to Use, No Environment Setup Required
- 🎨 Light/Dark Themes and Transparent Window - 🎨 Light/Dark Themes and Transparent Window
@ -77,36 +78,7 @@ Cherry Studio is a desktop client that supports for multiple LLM providers, avai
# 🖥️ Develop # 🖥️ Develop
## IDE Setup Refer to the [development documentation](docs/dev.md)
[Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Project Setup
### Install
```bash
yarn
```
### Development
```bash
yarn dev
```
### Build
```bash
# For windows
$ yarn build:win
# For macOS
$ yarn build:mac
# For Linux
$ yarn build:linux
```
# 🤝 Contributing # 🤝 Contributing

View File

@ -55,6 +55,7 @@ Cherry Studioは、複数のLLMプロバイダーをサポートするデスク
- 🔌 ミニプログラム対応 - 🔌 ミニプログラム対応
5. **優れたユーザー体験** 5. **優れたユーザー体験**
- 🖥️ Windows、Mac、Linux のクロスプラットフォーム対応 - 🖥️ Windows、Mac、Linux のクロスプラットフォーム対応
- 📦 環境構築不要ですぐに使用可能 - 📦 環境構築不要ですぐに使用可能
- 🎨 ライト/ダークテーマと透明ウィンドウ対応 - 🎨 ライト/ダークテーマと透明ウィンドウ対応
@ -78,36 +79,7 @@ Cherry Studioは、複数のLLMプロバイダーをサポートするデスク
# 🖥️ 開発 # 🖥️ 開発
## IDEの設定 参考[開発ドキュメント](dev.md)
[Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## プロジェクトの設定
### インストール
```bash
$ yarn
```
### 開発
```bash
$ yarn dev
```
### ビルド
```bash
# Windowsの場合
$ yarn build:win
# macOSの場合
$ yarn build:mac
# Linuxの場合
$ yarn build:linux
```
# 🤝 貢献 # 🤝 貢献

View File

@ -54,6 +54,7 @@ Cherry Studio 是一款支持多个大语言模型LLM服务商的桌面客
- 🔌 小程序支持 - 🔌 小程序支持
5. **优质使用体验** 5. **优质使用体验**
- 🖥️ Windows、Mac、Linux 跨平台支持 - 🖥️ Windows、Mac、Linux 跨平台支持
- 📦 开箱即用,无需配置环境 - 📦 开箱即用,无需配置环境
- 🎨 支持明暗主题与透明窗口 - 🎨 支持明暗主题与透明窗口
@ -77,36 +78,7 @@ Cherry Studio 是一款支持多个大语言模型LLM服务商的桌面客
# 🖥️ 开发 # 🖥️ 开发
## IDE 设置 参考[开发文档](dev.md)
[Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## 项目设置
### 安装
```bash
$ yarn
```
### 开发
```bash
$ yarn dev
```
### 构建
```bash
# Windows
$ yarn build:win
# macOS
$ yarn build:mac
# Linux
$ yarn build:linux
```
# 🤝 贡献 # 🤝 贡献

51
docs/dev.md Normal file
View File

@ -0,0 +1,51 @@
# 🖥️ Develop
## IDE Setup
[Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Project Setup
### Install
```bash
yarn
```
### Development
### Setup Node.js
Download and install [Node.js v20.x.x](https://nodejs.org/en/download)
### Setup Yarn
```bash
corepack enable
corepack prepare yarn@4.6.0 --activate
```
### Install Dependencies
```bash
yarn install
```
### Start
```bash
yarn dev
```
### Build
```bash
# For windows
$ yarn build:win
# For macOS
$ yarn build:mac
# For Linux
$ yarn build:linux
```