Generate a GitHub-style README.md by analyzing codebase manifests and source files.
npx skills add https://github.com/ohnotnow/agentic-stuff --skill readme-ohnotnow
Please help me install this Agent Skill. Skill: readme Source: https://github.com/ohnotnow/agentic-stuff/tree/main/skills/readme Command: npx skills add https://github.com/ohnotnow/agentic-stuff --skill readme-ohnotnow
Generate a high-quality README.md by analyzing the actual codebase, ensuring the documentation reflects the current project.
Provide the project directory to the skill and it will generate a complete, GitHub-style README.md from the codebase.
High-intent search queries and answers about installing and using this skill.
To auto-generate a README.md, provide your project directory to the skill. It reads actual codebase manifests and source files to produce a complete, GitHub-style README reflecting current project structure, prerequisites, and setup commands.
Yes, you can generate project setup and testing steps by analyzing manifests. The skill validates findings against manifest files and entry points to ensure accurate, up-to-date documentation for prerequisites and testing commands.
The README generator works across multiple stacks and project types. It detects project structure by reading actual source files and manifests, grounding the generated README content in the real repository regardless of the specific framework.
Keep your GitHub README up-to-date by re-running the skill to re-read the codebase on demand. This ensures the generated documentation reflects current entry points, manifests, and key directories after code changes.
The best way to scaffold documentation for an existing project is to analyze the actual codebase. The skill reads source files and manifests to detect project structure, automatically producing accurate contribution guidelines and setup instructions.
A limitation when generating a README from source files is dependency on actual manifests and key directories for validation. If the codebase lacks clear entry points or standard manifest files, the generated documentation accuracy may decrease.
ianphilRead the README.md and list repository files with git ls-files to identify entry points.
silva2kandGenerate a README.md file from provided project details and requirements.
PaneriVatsalGenerate developer-facing documentation from repository structure and source files.
channgGenerate static documentation websites from markdown files with sidebar navigation.
