Metadata-Version: 2.1
Name: readme-builder
Version: 0.1.0rc1
Summary: Create contextual README.md files
Author: Akshita Dixit
Author-email: akshitadixit.int@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown

## Readme Builder

This project aims to simplify the process of creating README.md files for software projects. It leverages Python and a command-line interface to generate comprehensive and informative README files based on the project structure and files present.

### Features

* **Automatic README Generation:** Analyzes project files and structure to automatically generate a well-formatted README.md file.
* **Project Overview:**  Provides a concise overview of the project's purpose and functionality.
* **Feature Listing:**  Identifies and lists key features based on the project's directory structure and file names.
* **Installation Instructions:**  Generates installation instructions tailored to the project's dependencies and environment management tools (e.g., `pip`, `conda`, `poetry`).
* **Usage Examples:**  Provides code examples and command-line instructions for running and using the project.

### Installation

This project utilizes `poetry` for dependency management and package installation. Ensure you have Poetry installed on your system. If not, follow the instructions at [https://python-poetry.org/docs/](https://python-poetry.org/docs/).

1. **Clone the repository:**
```bash
git clone https://github.com/your-username/readme-builder.git
```
2. **Navigate to the project directory:**
```bash
cd readme-builder
```
3. **Install dependencies:**
```bash
poetry install
```

### Usage

1. **Run the CLI:**
```bash
poetry run readme-builder
```

This will analyze the project structure and generate a `README.md` file in the current directory.

### License

This project is licensed under the MIT License.

### Contact Information

For any inquiries or feedback, please contact:

* **Email:** akshitadixit.int@gmail.com 

