skills.rest
FaysilAlshareef
FaysilAlshareefCOMMUNITY
Explore all skills by this author →
GitHub

readme-gen

Generate README files from .NET repository analysis with Mermaid diagrams.

4|1|Updated Mar 15, 2026
Search Tags:#architecture#documentation#readme#dotnet#badges#project-analysis#merge-update
One-click install
npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill readme-gen-faysilalshareef
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-gen
Source: https://github.com/FaysilAlshareef/dotnet-ai-kit/tree/main/skills/docs/readme-gen
Command: npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill readme-gen-faysilalshareef

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Projects often have out-of-date or missing README files that lack architecture overviews, setup instructions, and accurate badges; this Skill generates and updates READMEs by analyzing the repository so documentation reflects the actual codebase and configuration.

Core Features & Use Cases

  • Repository analysis: Detects .csproj files, TargetFramework, Program.cs, services, and test projects to infer project structure.
  • README generation & merging: Produces per-service or umbrella READMEs, merges with existing README content, and preserves custom sections.
  • Documentation output: Injects badges, prerequisites, setup steps, API/event summaries, and Mermaid architecture diagrams for microservices and generic projects.
  • Use case: Use when onboarding a new microservice repository or standardizing documentation across a .NET platform to ensure accurate setup and architecture guidance.

Quick Start

Use the readme-gen skill to automatically generate or update the project's README from repository analysis.

Frequently Asked Questions about readme-gen

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README for a .NET repository?▼

To generate a README for a .NET repository, the skill analyzes your .csproj files, Program.cs, and source files to detect frameworks, services, and tests, then automatically produces setup instructions, badges, and architecture diagrams.

Can I update an existing README without losing custom sections?▼

Yes, you can update an existing README without losing custom sections because the skill merges new generated content with existing documentation, detecting project changes while preserving your manually added sections.

How do I create architecture diagrams for microservices in a .NET project?▼

Creating architecture diagrams for .NET microservices is handled by the skill, which extracts project services and entry points to automatically format and inject Mermaid diagrams into your README documentation.

Does readme-gen work with Directory.Build.props for framework detection?▼

Yes, readme-gen works with Directory.Build.props by extracting this file alongside .csproj and Program.cs to accurately determine target frameworks and infer the overall project structure.

What is the best way to standardize documentation across a .NET platform?▼

The best way to standardize .NET platform documentation is using the skill to generate umbrella READMEs, ensuring each microservice has accurate prerequisites, API summaries, and architecture guidance.

Can I generate per-service README files for a microservice architecture?▼

Yes, you can generate per-service README files for microservice architectures, as the skill detects individual project types and test projects to produce tailored setup instructions and API summaries for each service.

Related Skills

Explore More Software Engineering Skills→
wshaddixwshaddix
71

dotnet-project-analysis

Analyze .NET solution structure, project references, and build configuration.

Community
Advanced
JocysComJocysCom
206

mermaid-rasterize

Convert mermaid block diagrams in markdown files to PNG images.

Official
Intermediate
AGIBuildAGIBuild
10

dotnet-add-testing

Scaffold xUnit test projects with Coverlet and build configurations for .NET.

Community
Intermediate
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate