# Readme generator

> Readme generator is an open-source agent skill for files and documents. Auto-generates professional README.md files for Arduino/ESP32/RP2040 projects following open-source best practices. It is available on Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf and Goose.

- **Kind:** Skill
- **Pricing:** Open source
- **Platforms:** Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf, Goose
- **Website:** https://github.com/wedsamuel1230/embedded-engineering-skills/tree/main/skills/readme-generator
- **Repository:** https://github.com/wedsamuel1230/embedded-engineering-skills
- **GitHub stars:** 32
- **License:** MIT
- **Skill name:** readme-generator
- **Collection:** https://github.com/wedsamuel1230/embedded-engineering-skills
- **Categories:** files and documents
- **Listing updated:** 2026-11-17

## About

Auto-generates professional README.md files for Arduino/ESP32/RP2040 projects following open-source best practices. Use when user wants to document their project for GitHub, needs help writing a README, or says "make my project shareable". Follows awesome-readme standards with sections for Overview, Hardware, Software, Setup, Usage, Troubleshooting, and Contributing.

## When your agent uses it

> Auto-generates professional README.md files for Arduino/ESP32/RP2040 projects following open-source best practices. Use when user wants to document their project for GitHub, needs help writing a README, or says "make my project shareable". Follows awesome-readme standards with sections for Overview, Hardware, Software, Setup, Usage, Troubleshooting, and Contributing.

## What it can access

From a static check of the files on GitHub; nothing was run.

- [Runs Python scripts](https://github.com/wedsamuel1230/embedded-engineering-skills/tree/HEAD/skills/readme-generator)
- [No network calls found in its scripts](https://github.com/wedsamuel1230/embedded-engineering-skills/tree/HEAD/skills/readme-generator)
- [License: MIT](https://github.com/wedsamuel1230/embedded-engineering-skills/tree/HEAD/skills/readme-generator)

## Install

### Claude Code

This skill ships in the `embedded-engineering-skills` plugin. In Claude Code, add the marketplace and install the plugin (it may include other skills too):

```sh
/plugin marketplace add wedsamuel1230/embedded-engineering-skills
/plugin install embedded-engineering-skills@embedded-engineering-skills
```

Or copy only this skill to `~/.claude/skills/readme-generator`:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/wedsamuel1230/embedded-engineering-skills.git "$tmp" &&
mkdir -p ~/.claude/skills &&
rm -rf ~/.claude/skills/readme-generator &&
cp -R "$tmp/skills/readme-generator" ~/.claude/skills/readme-generator &&
rm -rf "$tmp"
```

For one project only, put the folder in `.claude/skills/readme-generator` inside it instead.

### Codex

Copy the skill folder to `~/.agents/skills/readme-generator` to use it in every repository:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/wedsamuel1230/embedded-engineering-skills.git "$tmp" &&
mkdir -p ~/.agents/skills &&
rm -rf ~/.agents/skills/readme-generator &&
cp -R "$tmp/skills/readme-generator" ~/.agents/skills/readme-generator &&
rm -rf "$tmp"
```

For one repository only, put the folder in `.agents/skills/readme-generator` inside it instead.

### Cursor

Copy the skill folder to `~/.cursor/skills/readme-generator` to use it in every project:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/wedsamuel1230/embedded-engineering-skills.git "$tmp" &&
mkdir -p ~/.cursor/skills &&
rm -rf ~/.cursor/skills/readme-generator &&
cp -R "$tmp/skills/readme-generator" ~/.cursor/skills/readme-generator &&
rm -rf "$tmp"
```

For one project only, put the folder in `.cursor/skills/readme-generator` inside it instead.

### Gemini CLI

Run in a terminal (add `--scope workspace` to install it for the current workspace only):

```sh
gemini skills install https://github.com/wedsamuel1230/embedded-engineering-skills.git --path skills/readme-generator
```

Or copy the folder to `~/.gemini/skills/readme-generator` yourself.

### VS Code

For GitHub Copilot in VS Code, copy the skill folder to `~/.copilot/skills/readme-generator`:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/wedsamuel1230/embedded-engineering-skills.git "$tmp" &&
mkdir -p ~/.copilot/skills &&
rm -rf ~/.copilot/skills/readme-generator &&
cp -R "$tmp/skills/readme-generator" ~/.copilot/skills/readme-generator &&
rm -rf "$tmp"
```

For one project only, put the folder in `.github/skills/readme-generator` inside it instead.

### Other agents

Get the folder:

```sh
git clone --depth 1 https://github.com/wedsamuel1230/embedded-engineering-skills.git
```

Then copy `embedded-engineering-skills/skills/readme-generator` into your agent's skills folder as `readme-generator`. Agents that support SKILL.md read one folder per skill.

## FAQ

### How do I install Readme generator in Claude Code?

Copy the skill folder from GitHub to ~/.claude/skills/readme-generator to use it in all your projects, or to .claude/skills/readme-generator in one project. Or install the embedded-engineering-skills plugin, which includes it: /plugin marketplace add wedsamuel1230/embedded-engineering-skills, then /plugin install embedded-engineering-skills@embedded-engineering-skills.

### Does Readme generator run scripts?

Yes. It runs Python scripts. No network calls were found in its scripts. This comes from a static check of the files on GitHub; nothing was run. Read the files before you install it.

### Which AI agents can use Readme generator?

Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf and Goose. Each reads skills in the SKILL.md format from its own folder; the install steps on this page list them.

### What are the best alternatives to Readme generator?

The closest alternatives to Readme generator are DOCX, XLSX, PDF, Drawio and Doc and modernize.

## Alternatives

- [DOCX](https://ai-powered.com/skills/docx-anthropics): DOCX is an agent skill for files and documents.
- [XLSX](https://ai-powered.com/skills/xlsx): XLSX is an agent skill for files and documents.
- [PDF](https://ai-powered.com/skills/pdf-anthropics): PDF is an agent skill for files and documents.
- [Drawio](https://ai-powered.com/skills/drawio): Drawio is an open-source agent skill for files and documents.
- [Doc and modernize](https://ai-powered.com/skills/doc-and-modernize): Doc and modernize is an open-source agent skill for files and documents.
- [Markdown to word mermaid](https://ai-powered.com/skills/markdown-to-word-mermaid): Markdown to word mermaid is an open-source agent skill for files and documents.
- [Convert plaintext to md](https://ai-powered.com/skills/convert-plaintext-to-md): Convert plaintext to md is an open-source agent skill for files and documents.
- [Pdftk server](https://ai-powered.com/skills/pdftk-server): Pdftk server is an open-source agent skill for files and documents.

---
Source: https://ai-powered.com/skills/readme-generator
