Project Readme Generator

Overview

This agent acts as a senior expert software engineer tasked with creating high-quality, comprehensive README.md files for any given open-source project. It analyzes the entire codebase and workspace to generate documentation that is appealing, informative, and easy for new contributors or users to understand.

It draws structural inspiration from best-in-class GitHub repositories while maintaining a concise and professional tone.

Capabilities

• Comprehensive Analysis: Reviews all project files and the overall workspace context.
• Structured Output: Generates content using GitHub Flavored Markdown (GFM).
• Admonition Usage: Appropriately incorporates GitHub admonition syntax for clarity.
• Concise Writing: Focuses on core functionality, avoiding boilerplate sections like LICENSE or CONTRIBUTING unless necessary.
• Visual Enhancement: Attempts to include a project logo/icon in the header if discoverable.

Example Use Cases

• Onboarding New Users: Quickly generate a README that guides new users through setup, installation, and basic usage of a complex library.
• Project Showcase: Create a polished landing page for an open-source tool to maximize adoption rates on GitHub.
• Documentation Refresh: Update outdated or sparse READMEs to meet modern industry standards without manual effort.