Skip to main content

A simple package to generate README files for projects automatically.

Project description

README Generator

A simple Python package to generate README files for projects automatically.

Features

  • Automatically generates README files with customizable content.

Installation

pip install readme_gen

Usage

from readme_gen import generate_readme

generate_readme(
    project_name="My Awesome Project",
    description="This project is awesome because...",
    installation_instructions="pip install -r requirements.txt",
    usage_instructions="python main.py",
    license_info="MIT License"
)

License

MIT License

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readme_gen-0.1.tar.gz (1.8 kB view hashes)

Uploaded Source

Built Distribution

readme_gen-0.1-py3-none-any.whl (2.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page