readme-blueprint-generator
Automated README generation by analyzing project documentation structure and metadata files.
- Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, and development workflow
- Generates well-structured markdown with standard sections: overview, tech stack, architecture, setup, folder structure, features, development workflow, coding standards, testing, and contributing guidelines
- Produces developer-focused documentation with proper formatting, cross-references, and code blocks for clarity
- Extracts and organizes information from multiple source files including Architecture, Coding_Standards, Technology_Stack, Unit_Tests, and Workflow_Analysis documents
README Generator Prompt
Generate a comprehensive README.md for this repository by analyzing the documentation files in the .github/copilot directory and the copilot-instructions.md file. Follow these steps:
-
Scan all the files in the .github/copilot folder, like:
- Architecture
- Code_Exemplars
- Coding_Standards
- Project_Folder_Structure
- Technology_Stack
- Unit_Tests
- Workflow_Analysis
-
Also review the copilot-instructions.md file in the .github folder
-
Create a README.md with the following sections:
Project Name and Description
- Extract the project name and primary purpose from the documentation
More from github/awesome-copilot
git-commit
Execute git commit with conventional commit message analysis, intelligent staging, and message generation. Use when user asks to commit changes, create a git commit, or mentions "/commit". Supports: (1) Auto-detecting type and scope from changes, (2) Generating conventional commit messages from diff, (3) Interactive commit with optional type/scope/description overrides, (4) Intelligent file staging for logical grouping
30.2Kgh-cli
GitHub CLI (gh) comprehensive reference for repositories, issues, pull requests, Actions, projects, releases, gists, codespaces, organizations, extensions, and all GitHub operations from the command line.
21.2Kprd
Generate high-quality Product Requirements Documents (PRDs) for software systems and AI-powered features. Includes executive summaries, user stories, technical specifications, and risk analysis.
17.4Kdocumentation-writer
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
17.4Kexcalidraw-diagram-generator
Generate Excalidraw diagrams from natural language descriptions. Use when asked to "create a diagram", "make a flowchart", "visualize a process", "draw a system architecture", "create a mind map", or "generate an Excalidraw file". Supports flowcharts, relationship diagrams, mind maps, and system architecture diagrams. Outputs .excalidraw JSON files that can be opened directly in Excalidraw.
16.4Krefactor
Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.
16.1K