Skip to content

Rewrite README tone and structure#14

Merged
yitianlian merged 1 commit intomainfrom
codex/rewrite-readme-tone
Mar 8, 2026
Merged

Rewrite README tone and structure#14
yitianlian merged 1 commit intomainfrom
codex/rewrite-readme-tone

Conversation

@yitianlian
Copy link
Collaborator

Summary

  • rewrite the English and Chinese READMEs in a less slogan-heavy, more repository-oriented style
  • foreground what the repo is, how to use it, and what files matter
  • keep the quick start accurate while reducing list-heavy marketing language
  • preserve acknowledgements and citation info in a cleaner structure

Reference style

  • reviewed README structures from OpenHands, aider, and RepoAgent for layout and pacing
  • rewrote this README to be more direct and easier to scan

Validation

  • re-ran the quick-start skill listing commands
  • verified .agents/skills and .claude/skills still list matching skills

@yitianlian yitianlian merged commit 4600ffe into main Mar 8, 2026
1 check passed
@yitianlian yitianlian deleted the codex/rewrite-readme-tone branch March 8, 2026 15:37
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