Skip to content

Generate README

Generate comprehensive README documentation for the current project.

Sections to Include

  1. Project Title & Description
  2. Clear, concise project description
  3. Key features and benefits
  4. Target audience

  5. Installation

  6. Prerequisites
  7. Step-by-step installation instructions
  8. Common installation issues and solutions

  9. Usage

  10. Basic usage examples
  11. Common use cases
  12. Code snippets with explanations

  13. Configuration

  14. Environment variables
  15. Configuration files
  16. Available options

  17. API Documentation (if applicable)

  18. Endpoint descriptions
  19. Request/response examples
  20. Authentication details

  21. Development

  22. Local setup instructions
  23. Running tests
  24. Code style guidelines
  25. Contribution guidelines

  26. Deployment

  27. Deployment instructions
  28. Environment-specific notes
  29. CI/CD information

  30. License & Credits

  31. License information
  32. Contributors
  33. Acknowledgments

Style Guidelines

  • Use clear, concise language
  • Include code examples where helpful
  • Use proper Markdown formatting
  • Add badges for build status, coverage, etc.
  • Include table of contents for long READMEs

Focus Area

If $1 is provided, focus on updating/improving that specific section. Otherwise, generate a complete README from scratch.