readme - Generate comprehensive project README
Explore a project codebase and write a comprehensive README covering setup, architecture, environment variables, and deployment.
Tags
Updated: 2026-10-06Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Explore project structure
- Identify technology stack
- Inspect configuration files
- Analyze database setup
- Document development commands
- Explain application architecture
- Document environment variables
- Identify deployment targets
- Write README.md
Inputs
- Project codebase
- Configuration files
- Database schema
- Dependency manifests
- Deployment configuration
- Environment variable definitions
Outputs
- README.md file
- Project documentation
Requirements
- Repository file access