# a-readme-generator-that-takes-a

> A README generator that takes a project directory as input and produces a well-structured README.md by anal...

- Author: Phil Bennett
- Repository: BennettPhil/skill-a-readme-generator-that-takes-a
- Version: 20260208145937
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-08
- Source: https://github.com/BennettPhil/skill-a-readme-generator-that-takes-a
- Web: https://mule.run/skillshub/@@BennettPhil/skill-a-readme-generator-that-takes-a~a-readme-generator-that-takes-a:20260208145937

---

---
name: a-readme-generator-that-takes-a
description: A README generator that takes a project directory as input and produces a well-structured README.md by anal...
version: 0.1.0
license: Apache-2.0
---

# Purpose
Implement the idea: A README generator that takes a project directory as input and produces a well-structured README.md by analyzing the codebase. It should detect the language, build system, and project structure automatically.

# Context
No additional context provided.

# Builder Influence
Use a concise, validation-first workflow derived from the selected builder guidance: --- name: test-driven-builder-v0 description: Evolved builder using structure_change mutation version: 0.1.0 license: Apache-2.0 ---

# Workflow
1. Clarify assumptions and constraints before implementation.
2. Produce a concrete implementation plan tied to the requested output.
3. Build the solution incrementally and verify each major step.
4. Add usage instructions and edge-case handling notes.
5. Validate outputs and report limitations explicitly.

# Validation Checklist
- Output files match the task and are runnable.
- Input validation and error handling are explicit.
- Instructions include test or verification steps.
- Any unsafe or illegal request is redirected to a safe alternative.