What is readme-generator?

A README generator for Arduino, ESP32, and RP2040 maker projects. It creates project documentation with sections for the project, hardware, software, wiring, and other sharing details.

Use it to prepare a maker project for GitHub or Instructables. It helps document components, libraries, wiring diagrams, features, photos, licenses, and the intended audience.

It removes the need to write and organize a project README from scratch. It can also scan an existing project to gather information for the document.

readme-generator — Skill for Claude Code by wedsamuel1230

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent

npx skills add wedsamuel1230/arduino-skills --skill readme-generator

Clone the repo

git clone --depth 1 https://github.com/wedsamuel1230/arduino-skills

Made for: Claude Code.

Or install arduino-skills, the plugin that ships this one along with the rest of its 33 skills.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/skills/wedsamuel1230/arduino-skills/readme-generator/github.svg)](https://agentmods.dev/skills/wedsamuel1230/arduino-skills/readme-generator)

Your own site

<a href="https://agentmods.dev/skills/wedsamuel1230/arduino-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/wedsamuel1230/arduino-skills/readme-generator/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/skills/wedsamuel1230/arduino-skills/readme-generator"><img src="https://agentmods.dev/badge/skills/wedsamuel1230/arduino-skills/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 80 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 3,278 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits

NVIDIA SkillSpector warn 7 Sept 2026

SkillSpector: 1 finding, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

medium analysis-evasion · line 1
Suspicious Unicode normalization or mixed-script content

Fix: Review the flagged content for security risks. Ensure no credentials, secrets, or sensitive data are exposed.

How audits are shown

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00080	$0.03278
Opus 5.5	$0.00032	$0.01311
Sonnet 5.5	$0.00016	$0.00656
Haiku 4.5	$0.00008	$0.00328

Measured 2mo ago against content hash 41259a5ef8cf, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

readme-generator scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/generate_readme.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/readme-generator/SKILL.md · 486 lines

How it starts

The opening of the file, as written. The whole thing — 486 lines — stays where its author put it; the contents beside it link to each section on GitHub.

README Generator

Creates professional, beginner-friendly README files for maker projects.

Resources

This skill includes bundled tools:

scripts/generate_readme.py - Full README generator with wiring diagrams and templates

Quick Start

Interactive mode:

uv run --no-project scripts/generate_readme.py --interactive

Quick generation:

uv run --no-project scripts/generate_readme.py --project "Weather Station" --board "ESP32" --output README.md

Scan existing project:

uv run --no-project scripts/generate_readme.py --scan /path/to/arduino/project --output README.md

When to Use

"Help me document this project"
"I want to share this on GitHub"
"Write a README for my project"
User has working project, needs documentation
Before publishing to GitHub/Instructables

Information Gathering

Ask User For:

1. Project name and one-line description
2. What problem does it solve / why did you build it?
3. Main features (3-5 bullet points)
4. Hardware components used
5. Software libraries required
6. Any photos/videos/GIFs available?
7. License preference (MIT recommended for open source)
8. Target audience (beginners/intermediate/advanced)

Auto-Extract From Code:

Pin assignments from config.h
Library includes
WiFi/Bluetooth features
Sensor types

README Template

Generate using this structure (based on awesome-readme best practices):

# 🎯 [Project Name]

![Project Status](https://img.shields.io/badge/status-active-brightgreen)
![Platform](https://img.shields.io/badge/platform-ESP32-blue)
![License](https://img.shields.io/badge/license-MIT-green)

> One-line description of what this project does and why it's useful.

![Project Photo/GIF](images/project-demo.gif)

## 📋 Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Hardware Components](#hardware-components)
- [Wiring Diagram](#wiring-diagram)
- [Software Dependencies](#software-dependencies)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## 🔍 Overview

[2-3 paragraphs explaining:]
- What the project does
- Why you built it / what problem it solves
- Who it's for (target audience)

### Demo

[Embed video or GIF showing project in action]

## ✨ Features

- ✅ Feature 1 - brief description
- ✅ Feature 2 - brief description
- ✅ Feature 3 - brief description
- 🚧 Planned: Feature 4 (coming soon)

## 🔧 Hardware Components

| Component | Quantity | Purpose | Notes |
|-----------|----------|---------|-------|
| [MCU Board] | 1 | Main controller | [version/variant] |
| [Sensor 1] | 1 | [function] | [I2C address, etc.] |
| [Display] | 1 | User interface | [resolution] |
| ... | ... | ... | ... |

**Estimated Cost:** $XX-XX

### Where to Buy

- [Component 1](link) - Amazon/AliExpress
- [Component 2](link) - Adafruit/SparkFun

## 📐 Wiring Diagram

![Wiring Diagram](images/wiring-diagram.png)

### Pin Connections

| MCU Pin | Component | Pin | Function |
|---------|-----------|-----|----------|
| GPIO21 | BME280 | SDA | I2C Data |
| GPIO22 | BME280 | SCL | I2C Clock |
| GPIO4 | LED | Anode | Status indicator |
| ... | ... | ... | ... |

## 💻 Software Dependencies

### Required Software

- [Arduino IDE](https://www.arduino.cc/en/software) (v2.0+) or [PlatformIO](https://platformio.org/)
- [Board package] - [installation link]

### Required Libraries

| Library | Version | Purpose | Install via |
|---------|---------|---------|-------------|
| [Library1] | >=1.0.0 | [function] | Library Manager |
| [Library2] | >=2.3.0 | [function] | Library Manager |
| ... | ... | ... | ... |

## 📦 Installation

### Option 1: Arduino IDE

1. **Install Arduino IDE**
   - Download from [arduino.cc](https://www.arduino.cc/en/software)
   
2. **Add Board Support** (if using ESP32/RP2040)

File → Preferences → Additional Board Manager URLs: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json

Then: Tools → Board → Boards Manager → Search "[board]" → Install

3. **Install Required Libraries**
- Sketch → Include Library → Manage Libraries
- Search and install each library from the table above

4. **Clone or Download This Repository**
```bash
git clone https://github.com/[username]/[repo-name].git

Or download ZIP and extract

Open the Project
- Open [project-name].ino in Arduino IDE

Option 2: PlatformIO (Recommended for Advanced Users)

Install VS Code + PlatformIO extension

Clone and open:

git clone https://github.com/[username]/[repo-name].git
cd [repo-name]
code .

PlatformIO will automatically install dependencies from platformio.ini

⚙️ Configuration

Before uploading, customize config.h:

// === NETWORK SETTINGS ===
#define WIFI_SSID     "your-wifi-name"
#define WIFI_PASSWORD "your-wifi-password"

Read the full file on GitHub · 486 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

scripts/generate_readme.py 15 KB runs code

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 486 lines · 80 tokens per session scan A 41259a5ef8cf

Subscribe to this mod's changes

readme-generator is a skill published in the GitHub repository wedsamuel1230/arduino-skills (24 stars, last pushed 2mo ago), licensed MIT. It adds 80 tokens to every session and 3,278 once invoked, about $0.0003 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Code Generation Hardware and IoT Writing and docs arduino embedded-systems maker mit-license skills

readme-generator next to 6 skills from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
readme-generatorwedsamuel1230/arduino-skills	Skill	24	2mo ago	MIT	A	80	Claude Code
cardputer-buddyanthropics/claude-plugins-official	Skill	46k	yesterday	Apache-2.0	A	109	Claude Code
developer-device-platform-basicsgoogle/skills	Skill	22k	yesterday	Apache-2.0	A	57	Claude Code, Codex
google-cloud-filestore-autoscalegoogle/skills	Skill	22k	yesterday	Apache-2.0	A	102	Claude Code, Codex
gke-ai-troubleshooting-tpu-dynamic-slices-monitoringgoogle/skills	Skill	22k	yesterday	Apache-2.0	A	107	Claude Code, Codex
gke-ai-troubleshooting-tpu-vbar-oomgoogle/skills	Skill	22k	yesterday	Apache-2.0	A	125	Claude Code, Codex
m5-onboardanthropics/claude-plugins-official	Skill	46k	yesterday	Apache-2.0	B	94	Claude Code