yatmn-readme

Installation
SKILL.md

Yatmn README

Purpose

Write repository README files that act as accurate project entrypoints: what the project is, why it exists, how to run it, how to develop it, and where deeper docs live.

README files should describe the project's current usable state. Do not turn README.md into a roadmap, progress report, task tracker, implementation plan, or changelog. Link to separate planning/progress docs only when they already exist and are useful to readers.

Default output is bilingual:

  • README.md: English primary version.
  • README.zh-CN.md: Chinese companion version.
  • Each file must link to the other near the top.
  • The Chinese file should be a faithful localized version of the English README, not a different document with extra claims.

Core Rule

Inspect the project before writing. Do not start from a generic README template. Treat the repository as the source of truth, and mark missing facts as TODO rather than inventing them.

Installs
3
First Seen
May 4, 2026
yatmn-readme — yatmn/yatmn-skills