Skip to content

Commit dd4206d

Browse files
committed
docs(README): 更新文档内容
- 调整徽章显示格式 - 更新特性说明,增加离线使用支持 - 添加开发与贡献章节 - 补充构建应用说明
1 parent a0829b4 commit dd4206d

3 files changed

Lines changed: 27 additions & 10 deletions

File tree

README.zh.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
[![GitHub 仓库](https://img.shields.io/badge/GitHub-仓库-0969da?logo=github)][RepositoryOnGithub]
1010

1111
**平台**
12-
[![Windows 10+exe](https://img.shields.io/badge/Windows_10+-exe-0078D4?logo=windows)][ReleaseOnGitee]
13-
[![WebPWA](https://img.shields.io/badge/Web-PWA-0078D4?logo=windows)][PwaApp]
12+
[![Windows 10+ (exe)](https://img.shields.io/badge/Windows_10+-exe-0078D4?logo=windows)][ReleaseOnGitee]
13+
[![Web (PWA)](https://img.shields.io/badge/Web-PWA-0078D4?logo=windows)][PwaApp]
1414

1515
**语言**
1616
**中文** |
@@ -25,16 +25,19 @@ _该应用程序目前仅支持中文。_
2525
## 特性
2626

2727
- 批量添加图片
28-
- 添加裁切线,方便裁切
29-
- 支持浏览器在线访问,安装应用到本地,暂时不支持 PWA 离线使用
28+
- 添加网格,方便裁切
29+
- Web (PWA) 版支持浏览器在线访问,也可以安装到桌面使用
30+
- 支持离线使用,包括 Web(PWA)版和 Tauri 版
3031

3132
## 软件截图
3233

3334
TODO
3435

35-
## 下载
36+
## 下载与安装
3637

37-
TODO
38+
您可以直接在浏览器中使用 Web (PWA) 版。如果您的浏览器支持 PWA 功能,您还可以将 PWA 版应用安装到桌面。
39+
40+
您也可以下载 Web (PWA) 版,以便离线运行和固定版本。
3841

3942
## 使用方法
4043

@@ -48,7 +51,7 @@ TODO
4851

4952
## 兼容性
5053

51-
### WebPWA版兼容性
54+
### Web (PWA) 版兼容性
5255

5356
本应用需要在支持打印功能的浏览器中打开,建议使用 Chrome v88 或者 Edge v88 更高版本浏览器打开本应用,**不能在微信、QQ 中打开**
5457

@@ -67,6 +70,10 @@ TODO
6770
| -------- | ---- | ----------------------------------- | ------------------- |
6871
| Windows | 运行 | 需要 WebView2 v88.0.0.0 或 更高版本 | 安装或更新 WebView2 |
6972

73+
## 开发与贡献
74+
75+
请参阅[《开发指南》](./docs/dev/README.md)[《贡献指南》](./docs/CONTRIBUTING.md)
76+
7077
## 许可证
7178

7279
```text

docs/CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
本项目欢迎任何形式的贡献!
44

5-
为了更好地理解开源贡献的流程,您可以参考《如何开源软件指南》中的“[为开源做贡献](https://opensource.guide/zh-hans/how-to-contribute/)章节。此外,《开源指北》中的“[尝试参与开源](https://gitee.com/opensource-guide/guide/participating/roles.html)章节也提供了详细的入门指导
5+
为了更好地理解开源贡献的流程,您可以参考《如何开源软件指南》中的“[为开源做贡献](https://opensource.guide/zh-hans/how-to-contribute/)。此外,《开源指北》中的“[尝试参与开源](https://gitee.com/opensource-guide/guide/participating/roles.html)章也提供了详细的入门指导
66

77
在提交贡献时,您需要遵守[贡献者公约](./CODE_OF_CONDUCT.zh.md)、各平台的规则以及当地法律法规。
88

@@ -36,6 +36,10 @@
3636

3737
详情请参考 `biome.json`
3838

39+
## 文档规范
40+
41+
遵守[《中文技术文档写作风格指南》](https://zh-style-guide.readthedocs.io/zh-cn/latest/index.html)
42+
3943
## GIT 提交规范
4044

4145
遵循 [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)

docs/dev/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## 技术栈
44

5-
- 开发语言:TypeScript
5+
- 开发语言:[TypeScript](https://www.typescriptlang.org/)
6+
- UI 框架:[Solid](https://www.solidjs.com/)
7+
- UI 组件库:[Suid](https://suid.dev/)
8+
- 构建工具:[Rsbuild](https://rsbuild.rs/)
69

710
## 🛠️ 开发准备
811

@@ -12,4 +15,7 @@ TODO
1215

1316
## 📦 构建应用
1417

15-
TODO
18+
| 类型 | 命令 |
19+
| ------------ | ---------------------- |
20+
| Web (PWA) 版 | `pnpm run build:web` |
21+
| Tauri 版 | `pnpm run build:tauri` |

0 commit comments

Comments
 (0)