diff --git a/README.md b/README.md index 3cf67d8368..eaedd615cb 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,42 @@ banner
-

English | 中文 | 日本語

+

English | 中文 | 日本語 | Official Site | Documents | Development | Feedback

+ + +
+ +[![][deepwiki-shield]][deepwiki-link] +[![][twitter-shield]][twitter-link] +[![][discord-shield]][discord-link] +[![][telegram-shield]][telegram-link] + +
+ + + +
+ +[![][github-stars-shield]][github-stars-link] +[![][github-forks-shield]][github-forks-link] +[![][github-release-shield]][github-release-link] +[![][github-contributors-shield]][github-contributors-link] + +
+ +
+ +[![][license-shield]][license-link] +[![][commercial-shield]][commercial-link] +[![][sponsor-shield]][sponsor-link] + +
+ +
+ Featured|HelloGitHub kangfenmao%2Fcherry-studio | Trendshift - Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt + Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt
# 🍒 Cherry Studio @@ -17,10 +49,6 @@ Cherry Studio is a desktop client that supports for multiple LLM providers, avai ❤️ Like Cherry Studio? Give it a star 🌟 or [Sponsor](docs/sponsor.md) to support the development! -# 📖 Guide - - - # 🌠 Screenshot ![](https://github.com/user-attachments/assets/36dddb2c-e0fb-4a5f-9411-91447bab6e18) @@ -114,14 +142,6 @@ Want to influence our roadmap? Join our [GitHub Discussions](https://github.com/ Welcome PR for more themes -# 🖥️ Develop - -Refer to the [development documentation](docs/dev.md) - -Refer to the [Architecture overview documentation](https://deepwiki.com/CherryHQ/cherry-studio) - -Refer to the [Branching Strategy](docs/branching-strategy-en.md) for contribution guidelines - # 🤝 Contributing We welcome contributions to Cherry Studio! Here are some ways you can contribute: @@ -134,6 +154,8 @@ We welcome contributions to Cherry Studio! Here are some ways you can contribute 6. **Community Engagement**: Join discussions and help users. 7. **Promote Usage**: Spread the word about Cherry Studio. +Refer to the [Branching Strategy](docs/branching-strategy-en.md) for contribution guidelines + ## Getting Started 1. **Fork the Repository**: Fork and clone it to your local machine. @@ -158,22 +180,34 @@ Thank you for your support and contributions!

-# 🌐 Community - -[Telegram](https://t.me/CherryStudioAI) | [Email](mailto:support@cherry-ai.com) | [Twitter](https://x.com/kangfenmao) - -# ☕ Sponsor - -[Buy Me a Coffee](docs/sponsor.md) - -# 📃 License - -[LICENSE](./LICENSE) - -# ✉️ Contact - - - # ⭐️ Star History -[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) +[![Star History Chart](https://api.star-history.com/svg?repos=CherryHQ/cherry-studio&type=Timeline)](https://star-history.com/#CherryHQ/cherry-studio&Timeline) + + +[deepwiki-shield]: https://img.shields.io/badge/Deepwiki-CherryHQ-0088CC?style=plastic +[deepwiki-link]: https://deepwiki.com/CherryHQ/cherry-studio +[twitter-shield]: https://img.shields.io/badge/Twitter-CherryStudioApp-0088CC?style=plastic&logo=x +[twitter-link]: https://twitter.com/CherryStudioApp +[discord-shield]: https://img.shields.io/badge/Discord-@CherryStudio-0088CC?style=plastic&logo=discord +[discord-link]: https://discord.gg/wez8HtpxqQ +[telegram-shield]: https://img.shields.io/badge/Telegram-@CherryStudioAI-0088CC?style=plastic&logo=telegram +[telegram-link]: https://t.me/CherryStudioAI + + +[github-stars-shield]: https://img.shields.io/github/stars/CherryHQ/cherry-studio?style=social +[github-stars-link]: https://github.com/CherryHQ/cherry-studio/stargazers +[github-forks-shield]: https://img.shields.io/github/forks/CherryHQ/cherry-studio?style=social +[github-forks-link]: https://github.com/CherryHQ/cherry-studio/network +[github-release-shield]: https://img.shields.io/github/v/release/CherryHQ/cherry-studio +[github-release-link]: https://github.com/CherryHQ/cherry-studio/releases +[github-contributors-shield]: https://img.shields.io/github/contributors/CherryHQ/cherry-studio +[github-contributors-link]: https://github.com/CherryHQ/cherry-studio/graphs/contributors + + +[license-shield]: https://img.shields.io/badge/License-AGPLv3-important.svg?style=plastic&logo=gnu +[license-link]: https://www.gnu.org/licenses/agpl-3.0 +[commercial-shield]: https://img.shields.io/badge/License-Contact-white.svg?style=plastic&logoColor=white&logo=telegram&color=blue +[commercial-link]: mailto:license@cherry-ai.com?subject=Commercial%20License%20Inquiry +[sponsor-shield]: https://img.shields.io/badge/Sponsor-FF6699.svg?style=plastic&logo=githubsponsors&logoColor=white +[sponsor-link]: https://github.com/CherryHQ/cherry-studio/blob/main/docs/sponsor.md diff --git a/docs/README.ja.md b/docs/README.ja.md index 2a88cf8e5b..9492ad1d4e 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -1,15 +1,46 @@

- banner + banner

- English | 中文 | 日本語
+ English | 中文 | 日本語 | 公式サイト | ドキュメント | 開発 | フィードバック

+ +
+ +[![][deepwiki-shield]][deepwiki-link] +[![][twitter-shield]][twitter-link] +[![][discord-shield]][discord-link] +[![][telegram-shield]][telegram-link] + +
+ + + +
+ +[![][github-stars-shield]][github-stars-link] +[![][github-forks-shield]][github-forks-link] +[![][github-release-shield]][github-release-link] +[![][github-contributors-shield]][github-contributors-link] + +
+ +
+ +[![][license-shield]][license-link] +[![][commercial-shield]][commercial-link] +[![][sponsor-shield]][sponsor-link] + +
+ +
+ Featured|HelloGitHub kangfenmao%2Fcherry-studio | Trendshift - Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt + Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt
# 🍒 Cherry Studio @@ -20,10 +51,6 @@ Cherry Studio は、複数の LLM プロバイダーをサポートするデス ❤️ Cherry Studio をお気に入りにしましたか?小さな星をつけてください 🌟 または [スポンサー](sponsor.md) をして開発をサポートしてください! -# 📖 ガイド - -https://docs.cherry-ai.com - # 🌠 スクリーンショット ![](https://github.com/user-attachments/assets/36dddb2c-e0fb-4a5f-9411-91447bab6e18) @@ -117,14 +144,6 @@ https://docs.cherry-ai.com より多くのテーマの PR を歓迎します -# 🖥️ 開発 - -[開発ドキュメント](dev.md)を参照してください - -[アーキテクチャ概要ドキュメント](https://deepwiki.com/CherryHQ/cherry-studio)を参照してください - -[ブランチ戦略](branching-strategy-en.md)を参照して貢献ガイドラインを確認してください - # 🤝 貢献 Cherry Studio への貢献を歓迎します!以下の方法で貢献できます: @@ -137,6 +156,8 @@ Cherry Studio への貢献を歓迎します!以下の方法で貢献できま 6. **コミュニティの参加**:ディスカッションに参加し、ユーザーを支援します 7. **使用の促進**:Cherry Studio を広めます +[ブランチ戦略](branching-strategy-en.md)を参照して貢献ガイドラインを確認してください + ## 始め方 1. **リポジトリをフォーク**:フォークしてローカルマシンにクローンします @@ -161,22 +182,34 @@ Cherry Studio への貢献を歓迎します!以下の方法で貢献できま

-# 🌐 コミュニティ - -[Telegram](https://t.me/CherryStudioAI) | [Email](mailto:support@cherry-ai.com) | [Twitter](https://x.com/kangfenmao) - -# ☕ スポンサー - -[開発者を支援する](sponsor.md) - -# 📃 ライセンス - -[LICENSE](../LICENSE) - -# ✉️ お問い合わせ - -yinsenho@cherry-ai.com - # ⭐️ スター履歴 -[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) +[![Star History Chart](https://api.star-history.com/svg?repos=CherryHQ/cherry-studio&type=Timeline)](https://star-history.com/#CherryHQ/cherry-studio&Timeline) + + +[deepwiki-shield]: https://img.shields.io/badge/Deepwiki-CherryHQ-0088CC?style=plastic +[deepwiki-link]: https://deepwiki.com/CherryHQ/cherry-studio +[twitter-shield]: https://img.shields.io/badge/Twitter-CherryStudioApp-0088CC?style=plastic&logo=x +[twitter-link]: https://twitter.com/CherryStudioApp +[discord-shield]: https://img.shields.io/badge/Discord-@CherryStudio-0088CC?style=plastic&logo=discord +[discord-link]: https://discord.gg/wez8HtpxqQ +[telegram-shield]: https://img.shields.io/badge/Telegram-@CherryStudioAI-0088CC?style=plastic&logo=telegram +[telegram-link]: https://t.me/CherryStudioAI + + +[github-stars-shield]: https://img.shields.io/github/stars/CherryHQ/cherry-studio?style=social +[github-stars-link]: https://github.com/CherryHQ/cherry-studio/stargazers +[github-forks-shield]: https://img.shields.io/github/forks/CherryHQ/cherry-studio?style=social +[github-forks-link]: https://github.com/CherryHQ/cherry-studio/network +[github-release-shield]: https://img.shields.io/github/v/release/CherryHQ/cherry-studio +[github-release-link]: https://github.com/CherryHQ/cherry-studio/releases +[github-contributors-shield]: https://img.shields.io/github/contributors/CherryHQ/cherry-studio +[github-contributors-link]: https://github.com/CherryHQ/cherry-studio/graphs/contributors + + +[license-shield]: https://img.shields.io/badge/License-AGPLv3-important.svg?style=plastic&logo=gnu +[license-link]: https://www.gnu.org/licenses/agpl-3.0 +[commercial-shield]: https://img.shields.io/badge/商用ライセンス-お問い合わせ-white.svg?style=plastic&logoColor=white&logo=telegram&color=blue +[commercial-link]: mailto:license@cherry-ai.com?subject=商業ライセンスについて +[sponsor-shield]: https://img.shields.io/badge/スポンサー-FF6699.svg?style=plastic&logo=githubsponsors&logoColor=white +[sponsor-link]: https://github.com/CherryHQ/cherry-studio/blob/main/docs/sponsor.md diff --git a/docs/README.zh.md b/docs/README.zh.md index f4a8feda66..d4f2932262 100644 --- a/docs/README.zh.md +++ b/docs/README.zh.md @@ -1,14 +1,46 @@

- banner + banner

- English | 中文 | 日本語
+ English | 中文 | 日本語 | 官方网站 | 文档 | 开发 | 反馈

+ + +
+ +[![][deepwiki-shield]][deepwiki-link] +[![][twitter-shield]][twitter-link] +[![][discord-shield]][discord-link] +[![][telegram-shield]][telegram-link] + +
+ + + +
+ +[![][github-stars-shield]][github-stars-link] +[![][github-forks-shield]][github-forks-link] +[![][github-release-shield]][github-release-link] +[![][github-contributors-shield]][github-contributors-link] + +
+ +
+ +[![][license-shield]][license-link] +[![][commercial-shield]][commercial-link] +[![][sponsor-shield]][sponsor-link] + +
+ +
+ Featured|HelloGitHub kangfenmao%2Fcherry-studio | Trendshift - Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt + Cherry Studio - AI Chatbots, AI Desktop Client | Product Hunt
# 🍒 Cherry Studio @@ -124,14 +156,6 @@ https://docs.cherry-ai.com 欢迎 PR 更多主题 -# 🖥️ 开发 - -参考[开发文档](dev.md) - -参考[架构概览文档](https://deepwiki.com/CherryHQ/cherry-studio) - -参考[分支策略](branching-strategy-zh.md)了解贡献指南 - # 🤝 贡献 我们欢迎对 Cherry Studio 的贡献!您可以通过以下方式贡献: @@ -144,6 +168,8 @@ https://docs.cherry-ai.com 6. **社区参与**:加入讨论并帮助用户 7. **推广使用**:宣传 Cherry Studio +参考[分支策略](branching-strategy-zh.md)了解贡献指南 + ## 入门 1. **Fork 仓库**:Fork 并克隆到您的本地机器 @@ -168,22 +194,34 @@ https://docs.cherry-ai.com

-# 🌐 社区 - -[Telegram](https://t.me/CherryStudioAI) | [Email](mailto:support@cherry-ai.com) | [Twitter](https://x.com/kangfenmao) - -# ☕ 赞助 - -[赞助开发者](sponsor.md) - -# 📃 许可证 - -[LICENSE](../LICENSE) - -# ✉️ 联系我们 - -yinsenho@cherry-ai.com - # ⭐️ Star 记录 -[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) +[![Star History Chart](https://api.star-history.com/svg?repos=CherryHQ/cherry-studio&type=Timeline)](https://star-history.com/#CherryHQ/cherry-studio&Timeline) + + +[deepwiki-shield]: https://img.shields.io/badge/Deepwiki-CherryHQ-0088CC?style=plastic +[deepwiki-link]: https://deepwiki.com/CherryHQ/cherry-studio +[twitter-shield]: https://img.shields.io/badge/Twitter-CherryStudioApp-0088CC?style=plastic&logo=x +[twitter-link]: https://twitter.com/CherryStudioApp +[discord-shield]: https://img.shields.io/badge/Discord-@CherryStudio-0088CC?style=plastic&logo=discord +[discord-link]: https://discord.gg/wez8HtpxqQ +[telegram-shield]: https://img.shields.io/badge/Telegram-@CherryStudioAI-0088CC?style=plastic&logo=telegram +[telegram-link]: https://t.me/CherryStudioAI + + +[github-stars-shield]: https://img.shields.io/github/stars/CherryHQ/cherry-studio?style=social +[github-stars-link]: https://github.com/CherryHQ/cherry-studio/stargazers +[github-forks-shield]: https://img.shields.io/github/forks/CherryHQ/cherry-studio?style=social +[github-forks-link]: https://github.com/CherryHQ/cherry-studio/network +[github-release-shield]: https://img.shields.io/github/v/release/CherryHQ/cherry-studio +[github-release-link]: https://github.com/CherryHQ/cherry-studio/releases +[github-contributors-shield]: https://img.shields.io/github/contributors/CherryHQ/cherry-studio +[github-contributors-link]: https://github.com/CherryHQ/cherry-studio/graphs/contributors + + +[license-shield]: https://img.shields.io/badge/License-AGPLv3-important.svg?style=plastic&logo=gnu +[license-link]: https://www.gnu.org/licenses/agpl-3.0 +[commercial-shield]: https://img.shields.io/badge/商用授权-联系-white.svg?style=plastic&logoColor=white&logo=telegram&color=blue +[commercial-link]: mailto:license@cherry-ai.com?subject=商业授权咨询 +[sponsor-shield]: https://img.shields.io/badge/赞助支持-FF6699.svg?style=plastic&logo=githubsponsors&logoColor=white +[sponsor-link]: https://github.com/CherryHQ/cherry-studio/blob/main/docs/sponsor.md