Generating README Templates¶
Prompt 1: Creating Project README¶
Use Case: To help developers create comprehensive README files for their projects.
Prompt: You are creating a README file for a new project. The project details are as follows:
Project_name: {project_name}
Project_description: {project_description}
Technologies_used: {technologies_used}
Generate a README template, including:
- Project title and description.
- Installation and setup instructions.
- Usage examples and documentation.
## Usage
```python
from weather_client import WeatherClient
client = WeatherClient(api_key="your_api_key")
weather = client.get_current_weather(city="New York")
print(f"Temperature: {weather.temperature}°C")
Development¶
- Clone the repository
- Install dependencies:
pip install -r requirements.txt
- Run tests:
pytest
License¶
MIT