<div align="center">

  <h3 align="center">ReadmeCraft</h3>
  <p align="center">
    An automated README.md generator for your projects
    <br />
    <a href="https://github.com/370025263/auto_readme"><strong>Explore the docs »</strong></a>
    ·
    <a href="https://github.com/370025263/auto_readme/issues">Report Bug</a>
    ·
    <a href="https://github.com/370025263/auto_readme/issues">Request Feature</a>
  </p>
</div>

---

## About The Project

ReadmeCraft is a powerful tool that automatically generates professional `README.md` files for your projects. It analyzes your project structure, dependencies, and scripts to create comprehensive documentation with minimal effort. The tool integrates with LLMs (Large Language Models) to generate meaningful descriptions and even creates placeholder logos for your projects.

## Built With

- Python
- OpenAI API (for LLM integration)
- Rich (for console formatting)
- DrawSVG (for logo generation)

## Getting Started

### Prerequisites

- Python 3.7+
- OpenAI API key (if using LLM features)
- Git (for repository information extraction)

### Installation

1. Clone the repository
   ```sh
   git clone https://github.com/370025263/auto_readme.git
   ```
2. Install dependencies
   ```sh
   pip install -e .
   ```

## Usage

Run the following command in your project directory:
```sh
python -m readmecraft
```

The tool will:
1. Analyze your project structure
2. Generate descriptions for your scripts
3. Create a professional README.md file
4. Optionally generate a project logo

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Contact

[@virtueOre91](https://twitter.com/virtueOre91) - m370025263@gmail.com

Project Link: [https://github.com/370025263/auto_readme](https://github.com/370025263/auto_readme)

## Acknowledgments

* [OpenAI](https://openai.com)
* [Rich](https://github.com/Textualize/rich)
* [DrawSVG](https://github.com/cduck/drawsvg)

<p align="right">(<a href="#readme-top">back to top</a>)</p>