feat: 添加中文文档README_zh.md

This commit is contained in:
LEIJM 2025-08-17 00:01:11 +08:00
parent a071ba04c7
commit 8360ab1ca4
2 changed files with 90 additions and 1 deletions

View file

@ -2,7 +2,7 @@
<img src="/assets/banner.png" alt="Moodist Logo Banner" /> <img src="/assets/banner.png" alt="Moodist Logo Banner" />
<h2>Moodist 🌲</h2> <h2>Moodist 🌲</h2>
<p>Ambient sounds for focus and calm.</p> <p>Ambient sounds for focus and calm.</p>
<a href="https://moodist.mvze.net">Visit <strong>Moodist</strong></a> | <a href="https://buymeacoffee.com/remvze">Buy Me a Coffee</a> <a href="https://moodist.mvze.net">Visit <strong>Moodist</strong></a> | <a href="https://buymeacoffee.com/remvze">Buy Me a Coffee</a> | <a href="README_zh.md">中文文档</a>
</div> </div>
## Table of Contents ## Table of Contents

89
README_zh.md Normal file
View file

@ -0,0 +1,89 @@
<div align="center">
<img src="/assets/banner.png" alt="Moodist Logo Banner" />
<h2>Moodist 🌲</h2>
<p>专注与平静的环境音效。</p>
<a href="https://moodist.mvze.net">访问 <strong>Moodist</strong></a> | <a href="https://buymeacoffee.com/remvze">请我喝咖啡</a> | <a href="README.md">English</a>
</div>
## 目录
- ⚡ [功能特性](#功能特性)
- 🧰 [技术栈](#技术栈)
- 🔮 [命令说明](#命令说明)
- 🚧 [贡献指南](#贡献指南)
- ⭐ [支持项目](#支持-moodist)
- 📜 [许可证](#许可证)
## 功能特性
1. 🎵 超过75种环境音效
1. 📝 持久化音效选择
1. ✈️ 与他人分享音效选择
1. 🧰 自定义音效预设
1. 🌙 音效睡眠定时器
1. 📓 快速笔记记事本
1. 🍅 番茄钟计时器
1. ✅ 简单待办事项清单(即将推出)
1. ⏯️ 媒体控制
1. ⌨️ 全功能键盘快捷键
1. 🥷 注重隐私:无数据收集
1. 💰 完全免费、开源且可自托管
## 技术栈
- ⚡ **TypeScript**: 编程语言
- 🔨 **React**: UI库
- 🧑‍🚀 **Astro**: 元框架
- 🎨 **CSS Modules**: 样式
- 🐻 **Zustand**: 状态管理
- 🎭 **Framer Motion**: 动画库
- ⚙️ **Radix**: 无障碍组件
- 📕 **Storybook**: 组件文档
- 🧪 **Vitest**: 单元测试(即将推出)
- 🔭 **Playwright**: 端到端测试(即将推出)
- 🔍 **ESLint**: 代码检查
- 🧹 **Prettier**: 代码格式化
- 🧼 **Stylelint**: CSS检查
- 🐶 **Husky**: Git钩子
- 📝 **Lint Staged**: 对暂存文件运行检查器
- 🧽 **Commitlint**: Git提交检查
- 🧭 **Commitizen**: Git提交消息助手
- 📓 **Standard Version**: 版本管理和CHANGELOG生成
- 🧰 **PostCSS**: CSS转换
## 命令说明
- `npm run dev`: 运行开发服务器
- `npm run build`: 构建生产版本
- `npm run preview`: 预览构建的应用
- `npm run lint`: 使用ESLint检查文件
- `npm run lint:fix`: 使用ESLint检查并修复
- `npm run lint:style`: 使用Stylelint检查样式
- `npm run lint:style:fix`: 使用Stylelint检查并修复样式
- `npm run format`: 使用Prettier格式化文件
- `npm run commit`: 使用Commitizen提交消息
- `npm run release:major`: 发布主版本
- `npm run release:minor`: 发布次版本
- `npm run release:patch`: 发布补丁版本
- `npm run storybook`: 运行Storybook
## 贡献指南
🚧 请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 文件。
## 支持Moodist
⭐ 如果您喜欢这个项目,请给它一个星标。
☕ [请我喝咖啡](https://buymeacoffee.com/remvze) 来帮助我维护Moodist。
## 许可证
本项目采用 **MIT许可证** - 详情请参阅 [LICENSE](LICENSE) 文件。
### ⚠️ 第三方资源
本项目中使用的部分音效来源于第三方提供商,**受不同许可证约束**
- 使用 **Pixabay内容许可证** 的音效: [Pixabay内容许可证](https://pixabay.com/service/license-summary/)
- 使用 **CC0许可证** 的音效: [创作共用零许可证](https://creativecommons.org/publicdomain/zero/1.0/)