Bỏ qua tới nội dung
TakoAPI
Quay lại kỹ năng

readme-generator

bởi fratua

Coding Agents & IDEs
526Lượt tải do clawskills.sh công bố
0Lượt xem
0 lượt thíchĐăng nhập để thích kỹ năng này
—Chưa có đánh giá
Đánh giá của bạn

Tóm tắt

Generate a production-quality README.md by analyzing project structure, framework, and code.

Mô tả

Kỹ năng này làm gì

Analyzes a project's files, dependencies, and structure to produce a complete README.md. Detects the framework, package manager, license, and test setup automatically. Adapts output sections to the specific project type.

Manually writing a README requires cross-referencing package files, inferring commands, and structuring sections by hand — this skill does all of that in one pass.

Khi nào nên dùng

  • Adding a README to a new open source repo before first publish
  • Onboarding contributors to an undocumented internal tool
  • Generating a README after inheriting a legacy codebase
  • Documenting a CLI tool's flags and usage from source
  • Refreshing an outdated README after major refactors

Quy trình ví dụ

ĐẦU VÀO

User asks: generate a readme for my project

AGENT
  1. 1

    Reads package.json, pyproject.toml, or other manifests to extract name, description, and dependencies

  2. 2

    Detects framework from dependency signals and config files

  3. 3

    Determines install and run commands from lockfile type and scripts

  4. 4

    Scans for license file, CI workflows, Docker config, and test directories

  5. 5

    Writes a structured README.md with only the sections relevant to the detected project type

ĐẦU RA

README.md written to project root with badges, install instructions, usage examples, and framework-specific sections

Cài đặt

clawhub install fratua/readme-generator

Chạy lệnh CLI, hoặc dán prompt vào Claude Code, Cursor, Codex hay coding agent bạn đang dùng.

Liên kết