Readme generator

Skill minagayid/Agents/skills/library/readme-generator

Generate or improve a project README that helps someone understand, install, and use the project. Use when the user asks to write, scaffold, or improve a README.From its SKILL.md

Install

npx -y skills add minagayid/Agents --skill readme-generator

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.3 KB, as published. Nobody here has run it

README Generator

Write a README that gets a newcomer from zero to running quickly.

Steps

Infer the project from its files: language, entrypoints, manifests (package.json, pyproject.toml, etc.), scripts, and existing docs. Don't invent features.
Fill the structure below; drop sections that don't apply.

Structure

# Project Name
One sentence: what it is and who it's for.

## Features
- Key capabilities (3–6 bullets).

## Install
Exact commands, copy-pasteable.

## Usage
The smallest real example that shows value. Then a couple of common variations.

## Configuration
Env vars / config options as a table (name · default · description).

## Development
How to set up locally, run tests, and build.

## Contributing
Link CONTRIBUTING.md or state the basics.

## License
Name + link.

Guidelines

Put the most important thing first; a reader should grasp the project in 10 seconds.
Every command must actually work — verify against the repo.
Prefer a real, runnable example over prose.
Add badges/screenshots only if they carry information.