LogoClawIndex
CasesSkillsAbout
LogoClawIndex

readme-generator - Generate a standardized project README

Analyzes a project and generates a standardized README.md with relevant architecture, setup, testing, and documentation sections.

Tags

Updated: 2026-09-30
documentationREADMEproject analysisarchitectureMermaid

Capabilities

Analyze project structureRead project configurationIdentify system architectureGenerate Mermaid diagrams

Typical Inputs

Project pathProject filesExisting documentation

Typical Outputs

README.mdSystem design Mermaid sourceSystem design PNG

What this skill does

  • Analyze project structure
  • Read project configuration
  • Identify system architecture
  • Generate Mermaid diagrams
  • Manage supplementary documents
  • Write README.md

Inputs

  • Project path
  • Project files
  • Existing documentation
  • User-provided context

Outputs

  • README.md
  • System design Mermaid source
  • System design PNG
  • Supplementary documentation files

Requirements

  • Project filesystem access
  • Read and write permissions
  • Shell command access
  • mermaid-chart skill
  • doc-manager skill

Source

  • Spec: SKILL.md

ClawIndex

OpenClaw Skills & Use Case Index

ClawIndex is an ecosystem-driven index of OpenClaw skills and real-world use cases.

Index

Skills·
Cases

Meta

About·
Disclaimer·
Email·
GitHub
© 2026 ClawIndex All Rights Reserved.