Readme Generator

What This Skill Does

The Readme Generator is a powerful OpenClaw AI agent skill designed to bridge the gap between complex source code and accessible documentation. By autonomously scanning a project's file structure, configuration manifests (such as package.json, pyproject.toml, or Cargo.toml), and primary entry points, it synthesizes a professional, structured README.md file. It identifies installation commands, usage patterns, project structures, and licensing information to create a comprehensive overview that helps developers quickly understand or onboard onto a new project.

Installation

To integrate this skill into your OpenClaw environment, execute the following command in your terminal: clawhub install openclaw/skills/skills/sa9saq/readme-generator Once installed, the agent will have the necessary permissions to read project files and generate documentation directly within your working directory.

Use Cases

This skill is perfect for developers managing multiple repositories who need to maintain consistent, high-quality documentation. It is especially useful for onboarding new team members to legacy codebases that lack clear instructions, automating the boilerplate generation for new microservices, and cleaning up documentation for open-source releases. It handles complex scenarios like monorepos by identifying sub-packages and creating a unified documentation structure, ensuring that the root README links accurately to individual project components.

Example Prompts

1. "Analyze the current project directory and generate a professional README.md that includes installation instructions and a project structure overview."
2. "Look through this repository and create a README.generated.md that explains how to build the CLI tool and lists the available commands from the package.json scripts."
3. "Scan this folder and update my documentation with a new API Reference section based on the exported functions found in the src directory."

Tips & Limitations

To get the best results, ensure your project has descriptive filenames and clear command scripts defined in your config files. The generator prioritizes accuracy over creativity; it will not invent features that do not exist, ensuring your documentation remains truthful to the codebase. If an existing README is present, the skill defaults to generating a .generated.md file to prevent accidental data loss. Always review the output before finalizing. Note that while it handles multi-language codebases, it will output the documentation in English.