Metadata-Version: 2.1
Name: projectreadme
Version: 0.2.1
Summary: A package for generating Project README files for a github project
Home-page: https://github.com/Anmol-STRS/projectreadmegenerator
Author: Anmol Dhiman
Author-email: anmoldhimand666@gmail.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: google-generativeai
Requires-Dist: python-dotenv

## Project README Generator

This Python script automatically generates beautiful and informative README files for your projects. No more staring at a blank page, struggling to articulate what your project does! 

**Tired of writing repetitive README files? Let this script do it for you!** 

### ✨ Features

* **Effortless README Generation:** Simply answer a few questions about your project, and the script will generate a structured and well-formatted README file.
* **Customizable Sections:** Include the sections that matter most for your project, such as Installation, Usage, Contributing, and License.
* **Markdown Formatting:**  Generates READMEs in Markdown (.md) format, ready to be used on GitHub, GitLab, and other platforms.
* **Time-Saving:**  Focus on building your project, not writing lengthy documentation.

### 🚀 Getting Started

1. **Clone the repository:**

   ```bash
   git clone https://github.com/Anmol-STRS/projectreadmegenerator.git
   cd projectreadmegenerator
   ```

2. **Install the required packages:**

   ```bash
   pip install -r requirements.txt 
   ```

3. **Run the script:**

   ```bash
   python readme_generator.py
   ```

4. **Answer the prompts:** The script will guide you through a series of questions about your project.

5. **Enjoy your README!** The script will generate a `README.md` file in your project directory. 

### 🧰 Customization

You can easily tailor the generated README file by modifying the `README.md` file. This template uses placeholders that are replaced with your answers during the generation process.

### 🤝 Contributing

Contributions are welcome! If you have any ideas for improvement or new features, feel free to open an issue or submit a pull request.

###  License

This project is licensed under the MIT License - see the ([LICENSE](https://github.com/Anmol-STRS/projectreadmegenerator/blob/master/LICENSE)) file for details.
