skills.rest
ZardLi1115
ZardLi1115COMMUNITY
Explore all skills by this author →
GitHub

readme-skill

Generate fact-based GitHub README files from repository evidence and user confirmation.

31|Updated Aug 17, 2026
Search Tags:#documentation#markdown#github#readme#badges#open-source#bilingual
One-click install
npx skills add https://github.com/ZardLi1115/readme-skill --skill readme-skill-zardli1115
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-skill
Source: https://github.com/ZardLi1115/readme-skill
Command: npx skills add https://github.com/ZardLi1115/readme-skill --skill readme-skill-zardli1115

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Writing an accurate GitHub README often leads to invented commands, unverified badges, and unsupported claims. This Skill grounds every public statement in repository evidence or explicit user confirmation, and never writes files until the user approves the draft. ## Core Features & Use Cases - Bounded repository discovery: Scans manifests, licenses, CI configuration, and existing docs to build a fact ledger separating verified, confirmed, uncertain, and missing information. - Bilingual README generation: Produces English, Simplified Chinese, or bilingual README layouts with aligned technical identifiers and reciprocal language links. - Safe publication rules: Blocks unsupported commands, links, badges, architecture diagrams, and license claims; includes a mandatory verified Quick Start section and a pre-write quality checklist. - Use Case: Point the Skill at an open-source repository, choose whether to replace or extend the existing README, approve badges and an optional ASCII architecture diagram, then receive a confirmed bilingual README written only after your explicit approval. ## Quick Start Ask the agent to use readme-skill to create or update the README for a named repository, then answer its questions about language layout, badges, and imagery.

Frequently Asked Questions about readme-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an accurate GitHub README from my repository?▼

Invoke readme-skill against the repository and it performs a bounded scan of manifests, licenses, CI configuration, and existing docs before drafting. It asks about language layout, badges, and imagery, then writes README files only after you confirm the draft and target paths.

How to create a bilingual English and Chinese README for GitHub?▼

Choose the bilingual layout when prompted and the Skill produces README.md as the English landing page plus README.zh-CN.md as a natural Chinese rewrite. Commands, paths, URLs, versions, and badge destinations stay identical across both files with reciprocal language-switch links.

Does readme-skill overwrite an existing README automatically?▼

No. When an existing README is detected, the Skill stops and asks you to choose replace completely, replace with selected retained content, or extend in place. It never writes or modifies any README file until you explicitly request it.

Can the Skill generate README images and badges?▼

Yes. It recommends only Shields.io badges with verifiable sources and can generate a local hero image through an OpenAI-compatible Images API using scripts/generate-image.py. Credentials pass through environment variables and are never written to the repository.

Why does the README draft block on a missing Quick Start section?▼

Every generated README must contain a verified Quick Start showing the shortest path to a first useful result. If no verifiable first-use path exists in the repository or from the user, the Skill asks for those details instead of inventing or omitting the section.

Related Skills

Explore More Software Engineering Skills→
real-casereal-case

readme

Generate or update README.md files based on actual codebase analysis.

Community
Basic
amirbironamirbiron

skill-corner-post

Generates formatted Telegram channel posts promoting skills and publishes them via Postproxy.

Community
Intermediate
cofadecofade
16

ogp-external-positioning

Audit Open Garden Planner public claims and GPLv3 licensing compliance.

Community
Advanced
sergeiwallacesergeiwallace

research-doc

Write citation-validated research documents with adversarial review and provenance ledgers.

Community
Advanced