readme-generator

Generate README, CONTRIBUTING, and SECURITY files from repository source code.

Updated Jan 6, 2023

Search Tags:#automation #documentation #onboarding #readme #repository #maintainer

Ready to run

npx skills add https://github.com/pekral/phpstan-rules --skill readme-generator-pekral

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: readme-generator
Source: https://github.com/pekral/phpstan-rules/tree/main/.claude/skills/readme-generator
Command: npx skills add https://github.com/pekral/phpstan-rules --skill readme-generator-pekral

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the frustration of stale, inaccurate, or missing project documentation by automatically generating maintainer-ready files directly from your codebase.

Core Features & Use Cases

Zero-Hallucination Scanning: Extracts real commands, configuration keys, and setup steps directly from your manifests and source code.
Maintainer-Readiness: Produces professional README, CONTRIBUTING, and SECURITY files that reflect the current state of the project.
Use Case: When you add new features or change your installation process, use this Skill to ensure your README remains perfectly synced with your actual code without manual updates.

Quick Start

Use the readme-generator skill to scan the current repository and create a new README.md file that accurately reflects the project structure and installation commands.

Frequently Asked Questions about readme-generator

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

FAQPage Schema

How do I generate a README file from my source code automatically?▼

To generate a README automatically, this Skill scans your repository manifests, source code, and configuration files to extract verified commands and setup instructions without hallucinating external information. It produces maintainer-ready documentation reflecting the current project state.

What is the best way to keep project documentation synced with code changes?▼

The best way to keep project documentation synced is to scan the repository file system and extract accurate setup steps directly from manifests. This approach eliminates stale documentation by generating README files that reflect actual code updates.

Can I generate CONTRIBUTING and SECURITY files directly from my repository?▼

Yes, you can generate CONTRIBUTING and SECURITY files directly from your repository. The Skill scans your codebase and configuration files to produce professional, maintainer-ready documentation files that accurately reflect your current project structure.

Does the generated documentation rely on external data or hallucinated instructions?▼

Generated documentation does not rely on hallucinated instructions. The Skill requires direct access to the repository file system to extract real commands, configuration keys, and setup steps directly from your manifests and source code.

What do I need to scan a repository and create accurate setup instructions?▼

To scan a repository and create accurate setup instructions, you need direct access to the repository file system. The Skill reads manifests, source code, and configuration files to extract verified commands for maintainer-ready documentation.