Skip to content

docs(readme): restructure following codex-app-transfer template#39

Merged
Cmochance merged 1 commit into
mainfrom
docs/readme-refresh-v1.5.10
May 16, 2026
Merged

docs(readme): restructure following codex-app-transfer template#39
Cmochance merged 1 commit into
mainfrom
docs/readme-refresh-v1.5.10

Conversation

@Cmochance
Copy link
Copy Markdown
Owner

Summary

  • Restructure both README.md and README.zh-CN.md (currently byte-identical Chinese) to a richer, scannable layout patterned after the codex-app-transfer README: top nav row, badge row, differentiator pitch (plan + quota direct-read), then 能做什么 / 下载 / 快速开始 / 仓库结构 / 本地开发 / 桌面端打包 / 版本与发布 / 常见问题 / 技术栈 / 平台支持 / macOS 兼容脚本 / 免责声明 / 许可证.
  • Add a real FAQ section covering the recurring questions (missing Codex CLI, switch atomicity, quota/refresh cost guarantee, login-cancel UX, Custom Base ↔ ChatGPT OAuth mutual exclusion, macOS Gatekeeper / Windows SmartScreen, on-disk layout).
  • Current version pinned to v1.5.10.

Test plan

  • GitHub renders the README correctly (badges, code blocks, table-of-contents-like structure)
  • No broken local links (CHANGELOG.md, LICENSE, macOS-backup/, etc.)
  • CI green (docs-only — Linux check still expected to pass)

Drops the bullet-only feature list / packaging detail wall and replaces
with: header nav (中文 | Changelog | Releases) + badge row + a clearer
"differentiates from a pure swap script" pitch (plan + quota direct-read),
then sections for 能做什么 / 下载 (asset naming) / 快速开始 / 仓库结构
/ 本地开发 / 桌面端打包 / 版本与发布 / 常见问题 / 技术栈 / 平台支持
/ macOS 兼容脚本 / 免责声明 / 许可证.

FAQ block covers the questions actually surfacing in issues: missing
Codex CLI, switch atomicity, quota / refresh cost guarantee, login
cancel UX, Custom Base URL ↔ ChatGPT OAuth mutual exclusion, macOS
Gatekeeper / Windows SmartScreen, on-disk layout.

README.zh-CN.md kept in sync (both files were already byte-identical
Chinese; consolidation into a single primary + English mirror is a
separate cleanup).
@Cmochance Cmochance merged commit 07ff7c4 into main May 16, 2026
3 checks passed
@Cmochance Cmochance deleted the docs/readme-refresh-v1.5.10 branch May 16, 2026 06:33
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