agentleFS
techysytechysy/yangyu-hermes-skills/skills/software-development/readme-structure/SKILL.md

readme-structure

Skill8 starsChanged 35 days agoNo licenceView on GitHub

开源项目 README 结构规范 — 主版中文 + README.en.md 英文版,按读者分层,排障拆独立文档,用户价值优先。Use when writing, restructuring, or reviewing a README for any open-source project (GitHub repo).

The file

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.