Skip to content

docs(ui): refresh bilingual readme and add usage screenshots#18

Merged
jdjingdian merged 1 commit intomainfrom
dev
Mar 24, 2026
Merged

docs(ui): refresh bilingual readme and add usage screenshots#18
jdjingdian merged 1 commit intomainfrom
dev

Conversation

@jdjingdian
Copy link
Copy Markdown
Owner

背景

工具核心功能已基本完成,需要提升 GitHub 首页展示效果和上手效率。

本次改动

  1. 重构中英文 README(README.mdREADME_CN.md)结构与内容编排
  2. 新增“使用示意图 / Usage Screenshots”章节
  3. 新增 docs/images/ 并加入 3 张流程截图
  4. 图片引用改为相对路径,确保在 GitHub 正常渲染
  5. 同步更新功能亮点、兼容性、安装说明、构建说明与安全提示

影响范围

  • 仅文档与静态图片资源
  • 不涉及业务逻辑与二进制行为变更

验证

  • README/README_CN 目录锚点可跳转
  • 图片路径为相对路径并可渲染
  • 文档内容中英文基本对齐

restructure README.md and README_CN.md for better GitHub presentation
add toc, compatibility matrix, usage screenshots, and architecture flow
add docs/images workflow screenshots and use relative image paths
align install/build/security notes with the current implementation
@jdjingdian jdjingdian merged commit 4498e5f into main Mar 24, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant