Skip to content
Skill

Readme generator

Auto-generates professional README.md files for Arduino/ESP32/RP2040 projects following open-source best practices

Install
Scripts
Python
Platforms
Claude Code, Codex, Cursor
GitHub stars
32
Last commit
1 month ago
License
MIT
Listing updated
today

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.

From the skill's SKILL.md. Your agent reads this description to decide when to load the skill.

What it can access

From a static check of its 2 files (28 KB) on GitHub on 17 November 2026. Nothing was run. Read the files before you install a skill: it can tell your agent to run anything its tools allow.

Install

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):

/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:

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.

Claude Code docs on skills

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

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.

Codex docs on skills

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

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.

Cursor docs on skills

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

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.

Gemini CLI docs on skills

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

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.

VS Code docs on skills

Get the folder:

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.

The SKILL.md format

Readme generator 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.

More from wedsamuel1230/embedded-engineering-skills

  1. Use when users need Arduino CLI commands for board discovery, library installation, compilation, upload, or serial-port troubleshooting on W

    • Open source
    • 32 GitHub stars
  2. Generate Arduino and embedded C++ snippets for sensors, actuators, buses, state machines, timing, data logging, and hardware abstraction

    • Open source
    • 32 GitHub stars
  3. Build complete Arduino and embedded projects across Arduino IDE, Arduino CLI, PlatformIO, and vendor-specific toolchains

    • Open source
    • 32 GitHub stars
  4. Read and analyze Arduino or embedded serial output for structured runtime debugging across Arduino IDE, Arduino CLI, PlatformIO, and vendor-

    • Open source
    • 32 GitHub stars
  5. Route Arduino and embedded-system requests across Arduino IDE, Arduino CLI, PlatformIO, and vendor-specific tools

    • Open source
    • 32 GitHub stars
  6. Helps choose the right battery type and charging solution for Arduino/ESP32/RP2040 projects

    • Open source
    • 32 GitHub stars

Alternatives to Readme generator

  1. DOCX

    Skill

    Use this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files)

    • 196K GitHub stars
    • Files and documents
  2. XLSX

    Skill

    Use this skill any time a spreadsheet file is the primary input or output

    • 196K GitHub stars
    • Files and documents
  3. PDF

    Skill

    Use this skill whenever the user wants to do anything with PDF files

    • 196K GitHub stars
    • Files and documents
  4. Drawio

    Skill

    Generate draw.io diagrams as .drawio files and export to PNG/SVG/PDF with embedded XML

    • Open source
    • 41.3K GitHub stars
    • Files and documents
  5. Two related workflows for a locally-cloned codebase, in one skill

    • Open source
    • 41.3K GitHub stars
    • Files and documents
  6. Export Markdown containing Mermaid code fences to Word (.docx) with embedded SVG diagrams and PNG fallbacks

    • Open source
    • 41.3K GitHub stars
    • Files and documents