readme - Generate thorough project README documentation
Explores a codebase and creates or updates 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
- Map database schema
- Detect deployment targets
- Document local development
- Explain system architecture
- Document environment variables
- Write README.md
Inputs
- Project source code
- Configuration files
- Database schema
- Deployment configuration
- Environment variable documentation
Outputs
- README.md file
- Project setup instructions
- Architecture documentation
- Deployment guidance
- Environment variable reference
Requirements
- Access to the project codebase
- Permission to read project files
- Permission to write README.md