How do I install the Readme Generator skill?

Run npx skillmds@latest add davila7/readme-generator in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Readme Generator safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readme Generator?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readme Generator free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readme Generator?

davila7 (@davila7) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readme Generator by davila7 — Agent Skill

Name: Readme Generator
Author: davila7

File contents

Instructions

Step 1: Detect the project type

Check for language and framework indicators in this order:

package.json — Node.js / JavaScript / TypeScript project
pyproject.toml or setup.py — Python project
go.mod — Go project
Cargo.toml — Rust project
build.gradle or pom.xml — Java / Kotlin project
*.gemspec or Gemfile — Ruby project

Read whichever file is found to extract the project name, version, description, and dependencies.

Step 2: Read the entry point

Based on the project type, read the main entry point:

Node.js: check the main field in package.json, or look for src/index.ts, src/index.js, index.ts, index.js
Python: look for __main__.py, the module directory, or the entry point in pyproject.toml
Go: main.go or cmd/<name>/main.go
Rust: src/main.rs or src/lib.rs

Read the first 80 lines to understand what the project does.

Step 3: Survey the structure

Run ls -1 at the project root and at the src/ (or equivalent) directory if it exists. Note top-level directories that give structure clues (cli/, api/, lib/, tests/, docs/, examples/).

Step 4: Write the README

Produce a README.md with the following sections in this order. Include a section only if there is real content for it — do not leave placeholder text in any section except Badges.

# Project Name

One sentence describing what the project does and who it is for.

## Badges

<!-- Add badges here: build status, coverage, version, license -->

## Installation

Commands to install the project. Use the package manager detected in step 1.

## Usage

The minimal example to get something working. Show a command or code snippet.
If the project has a CLI, show the most common command.
If it is a library, show an import and a basic function call.

## Configuration

If the project has configuration options (environment variables, config files, flags),
list the important ones with their defaults and descriptions.

## Contributing

Brief instructions: how to set up a dev environment, how to run tests, how to submit a change.

## License

State the license. Read the LICENSE file if present to confirm.

After writing the README, tell the user which sections have placeholder content (Badges) and which sections they should review for accuracy (Usage examples especially benefit from human review).

---name: readme-generatordescription: Generate a README.md for the current project by analyzing the codebase structure, package files, and existing documentation. Use when asked to write a README, create documentation, or document the project.---## Instructions### Step 1: Detect the project typeCheck for language and framework indicators in this order:- `package.json` — Node.js / JavaScript / TypeScript project- `pyproject.toml` or `setup.py` — Python project- `go.mod` — Go project- `Cargo.toml` — Rust project- `build.gradle` or `pom.xml` — Java / Kotlin project- `*.gemspec` or `Gemfile` — Ruby projectRead whichever file is found to extract the project name, version, description, and dependencies.### Step 2: Read the entry pointBased on the project type, read the main entry point:- Node.js: check the `main` field in package.json, or look for `src/index.ts`, `src/index.js`, `index.ts`, `index.js`- Python: look for `__main__.py`, the module directory, or the entry point in pyproject.toml- Go: `main.go` or `cmd/<name>/main.go`- Rust: `src/main.rs` or `src/lib.rs`Read the first 80 lines to understand what the project does.### Step 3: Survey the structureRun `ls -1` at the project root and at the `src/` (or equivalent) directory if it exists. Note top-level directories that give structure clues (cli/, api/, lib/, tests/, docs/, examples/).### Step 4: Write the READMEProduce a README.md with the following sections in this order. Include a section only if there is real content for it — do not leave placeholder text in any section except Badges.```markdown# Project NameOne sentence describing what the project does and who it is for.## Badges## InstallationCommands to install the project. Use the package manager detected in step 1.## UsageThe minimal example to get something working. Show a command or code snippet.If the project has a CLI, show the most common command.If it is a library, show an import and a basic function call.## ConfigurationIf the project has configuration options (environment variables, config files, flags),list the important ones with their defaults and descriptions.## ContributingBrief instructions: how to set up a dev environment, how to run tests, how to submit a change.## LicenseState the license. Read the LICENSE file if present to confirm.```After writing the README, tell the user which sections have placeholder content (Badges) and which sections they should review for accuracy (Usage examples especially benefit from human review).

Frequently asked questions

Readme Generator