e07d4838a9
- Added a call-to-action in English, Japanese, and Chinese README files inviting users to star the project or sponsor its development. - Enhanced visibility of community engagement options to foster support for Cherry Studio.
144 lines
4.4 KiB
Markdown
144 lines
4.4 KiB
Markdown
<div align="center">
|
|
<a href="https://github.com/kangfenmao/cherry-studio/releases">
|
|
<img src="https://github.com/kangfenmao/cherry-studio/blob/main/build/icon.png?raw=true" width="150" height="150" alt="banner" />
|
|
</a>
|
|
</div>
|
|
<div align="center">
|
|
English | <a href="./docs/README.zh.md">中文</a> | <a href="./docs/README.ja.md">日本語</a>
|
|
</div>
|
|
|
|
# 🍒 Cherry Studio
|
|
|
|
Cherry Studio is a desktop client that supports for multiple LLM providers, available on Windows, Mac and Linux.
|
|
|
|
👏 Join [Telegram Group](https://t.me/CherryStudioAI)
|
|
|
|
❤️ Like Cherry Studio? Give it a star 🌟 or [Sponsor](docs/sponsor.md) to support the development!
|
|
|
|
# 🌠 Screenshot
|
|
|
|
|
|
|
|
|
|
|
|
# 🌟 Key Features
|
|
|
|
|
|
|
|
1. **Diverse LLM Provider Support**:
|
|
|
|
- ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more
|
|
- 🔗 AI Web Service Integration: Claude, Peplexity, Poe, and others
|
|
- 💻 Local Model Support with Ollama
|
|
|
|
2. **AI Assistants & Conversations**:
|
|
|
|
- 📚 300+ Pre-configured AI Assistants
|
|
- 🤖 Custom Assistant Creation
|
|
- 💬 Multi-model Simultaneous Conversations
|
|
|
|
3. **Document & Data Processing**:
|
|
|
|
- 📄 Support for Text, Images, Office, PDF, and more
|
|
- ☁️ WebDAV File Management and Backup
|
|
- 📊 Mermaid Chart Visualization
|
|
- 💻 Code Syntax Highlighting
|
|
|
|
4. **Practical Tools Integration**:
|
|
|
|
- 🔍 Global Search Functionality
|
|
- 📝 Topic Management System
|
|
- 🔤 AI-powered Translation
|
|
- 🎯 Drag-and-drop Sorting
|
|
- 🔌 Mini Program Support
|
|
|
|
5. **Enhanced User Experience**:
|
|
- 🖥️ Cross-platform Support for Windows, Mac, and Linux
|
|
- 📦 Ready to Use, No Environment Setup Required
|
|
- 🎨 Light/Dark Themes and Transparent Window
|
|
- 📝 Complete Markdown Rendering
|
|
- 🤲 Easy Content Sharing
|
|
|
|
# 🖥️ 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
|
|
|
|
```bash
|
|
$ yarn dev
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
# For windows
|
|
$ yarn build:win
|
|
|
|
# For macOS
|
|
$ yarn build:mac
|
|
|
|
# For Linux
|
|
$ yarn build:linux
|
|
```
|
|
|
|
# 🤝 Contributing
|
|
|
|
We welcome contributions to Cherry Studio! Here are some ways you can contribute:
|
|
|
|
1. **Contribute Code**: Develop new features or optimize existing code.
|
|
2. **Fix Bugs**: Submit fixes for any bugs you find.
|
|
3. **Maintain Issues**: Help manage GitHub issues.
|
|
4. **Product Design**: Participate in design discussions.
|
|
5. **Write Documentation**: Improve user manuals and guides.
|
|
6. **Community Engagement**: Join discussions and help users.
|
|
7. **Promote Usage**: Spread the word about Cherry Studio.
|
|
|
|
## Getting Started
|
|
|
|
1. **Fork the Repository**: Fork and clone it to your local machine.
|
|
2. **Create a Branch**: For your changes.
|
|
3. **Submit Changes**: Commit and push your changes.
|
|
4. **Open a Pull Request**: Describe your changes and reasons.
|
|
|
|
For more detailed guidelines, please refer to our [Contributing Guide](./CONTRIBUTING.md).
|
|
|
|
Thank you for your support and contributions!
|
|
|
|
# 🚀 Contributors
|
|
|
|
<a href="https://github.com/kangfenmao/cherry-studio/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=kangfenmao/cherry-studio" />
|
|
</a>
|
|
<br /><br />
|
|
|
|
# 🌐 Community
|
|
|
|
[Telegram](https://t.me/CherryStudioAI) | [Email](mailto:kangfenmao@gmail.com) | [Twitter](https://x.com/kangfenmao)
|
|
|
|
# 📣 Product Hunt
|
|
|
|
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry-studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
|
|
|
# ☕ Sponsor
|
|
|
|
[Buy Me a Coffee](docs/sponsor.md)
|
|
|
|
# 📃 License
|
|
|
|
[LICENSE](./LICENSE)
|
|
|
|
# ⭐️ Star History
|
|
|
|
[](https://star-history.com/#kangfenmao/cherry-studio&Timeline)
|