electronic-mcp-server: Skill for Claude Code

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 scripts/generate_readme.py --interactive

Quick generation:

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

Scan existing project:

uv run 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

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

Option 2: PlatformIO (Recommended for Advanced Users)

1. Install VS Code + PlatformIO extension

2. Clone and open:

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

3. 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"