readme blueprint generator
- Repo stars 0
- Author repo skills-registry
- Domain
- 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
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @tomevault-io · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# 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 -->
Sections and files
Listed in source order.
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
Key Features
Scans
.github/copilot/directory files for project metadata Reviewscopilot-instructions.mdfor development guidelines Extracts technology stack information Documents project architecture Includes getting started guidesWhen 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