---

name: readme-guide description: Guidelines for creating effective README files

README Guide

Structure

Copy# Project Name

Brief description.

## Quick Start
[How to get running fast]

## Installation
[Detailed installation]

## Usage
[How to use]

## Configuration
[Options and settings]

## Contributing
[How to contribute]

## License
[License info]

Best Practices

• Start with what it does
• Provide quick start
• Include examples
• Keep current
• Link to detailed docs