readme-blueprint-generator
- Repo stars 0
- Author repo skills-registry
README Blueprint Generator
Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.
Key Features
- Scans
.github/copilot/directory files for project metadata - Reviews
copilot-instructions.mdfor development guidelines - Extracts technology stack information
- Documents project architecture
- Includes getting started guides
- Lists folder structure and project organization
- Summarizes development workflow and coding standards
- Documents testing approaches
- Creates contribution guidelines
When to Use
- Creating initial README for a project
- Updating README to reflect architectural changes
- Standardizing documentation structure across projects
- Adding comprehensive onboarding information
- Generating developer-focused documentation
Generated Sections
- Project Name and Description
- Technology Stack with versions
- Project Architecture overview
- Getting Started and Installation
- Project Structure explanation
- Key Features and Functionality
- Development Workflow
- Coding Standards and Conventions
- Testing Approaches
- Contributing Guidelines
- Links to Additional Documentation
<!-- tomevault:4.0:skill_md:2026-05-23 -->Source: AICyberGuardian/storycraftr-next — distributed by TomeVault.
- Fluxly category
- Documentation
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Author / version / license
- @tomevault-io · no license declared
- Fluxly token estimate
- Lean
- Fluxly setup estimate
- Plug-and-play
- External API key
- No requirement detected
- Detected OS requirements
- Unspecified
- Runtime requirements
- Unspecified
- Detected file/system behavior
-
- Read-only
- Write / modify
- Detected network behavior
- Local-only
- Install commands
- None (reference only)
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
The current SKILL.md does not define a fixed output example. Scans .github/copilot/ directory files for project metadata Reviews copilot-instructions.md for development guidelines Extracts technology stack information
Creating initial README for a project Updating README to reflect architectural changes Standardizing documentation structure across projects
Project Name and Description Technology Stack with versions Project Architecture overview
# README Blueprint Generator
Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.
## Key Features
- Scans `.github/copilot/` directory files for project metadata
- Reviews `copilot-instructions.md` for development guidelines
- Extracts technology stack information
- Documents project architecture
- Includes getting started guides
- Lists folder structure and project organization
- Summarizes development workflow and coding standards
- Documents testing approaches
- Creates contribution guidelines
## When to Use
- Creating initial README for a project
- Updating README to reflect architectural changes
- Standardizing documentation structure across projects
- Adding comprehensive onboarding information
- Generating developer-focused documentation
## Generated Sections
- Project Name and Description
- Technology Stack with versions
- Project Architecture overview
- Getting Started and Installation
- Project Structure explanation
- Key Features and Functionality
- Development Workflow
- Coding Standards and Conventions
- Testing Approaches
- Contributing Guidelines
- Links to Additional Documentation
---
> Source: [AICyberGuardian/storycraftr-next](https://github.com/AICyberGuardian/storycraftr-next) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 --> Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.
sections -> Key Features → When to Use → Generated Sections
terms -> Generate a comprehensive README.md for your repository by analyzing existing documentation and codebase structure.
files/cmd -> .github/copilot/ · copilot-instructions.md · README.md · .github/copilot · AICyberGuardian/storycraftr-next · github.com/AICyberGuardian/storycraftr-next
body sha256 -> fa4356415a47
Decide Fit First
Design Intent
How To Use It
Boundaries And Review