work_docs_readme-generator

To generate a README.md automatically, run the skill on your project directory. It analyzes your repository structure and common files to produce a complete README.md with installation, usage, and API sections tailored to your project.

Automated README generation scans your repository to identify the project name, purpose, and tech stack. It detects typical files like package.json and requirements.txt to determine environmental needs, build commands, and folder structure for the documentation.

Yes, you can generate documentation for software projects of any language. The skill analyzes language-agnostic structure alongside specific dependency files like go.mod and pom.xml to tailor the README output to your detected tech stack.

The best way to create documentation for an evolving project is to generate a baseline README.md with quick customization placeholders. These placeholders guide future edits and updates as your project structure and features change over time.

You need typical project files like package.json, requirements.txt, go.mod, or pom.xml in your repository. The skill analyzes these files to detect your tech stack, build commands, environment variables, and folder structure for the generated documentation.