Skip to main content

Generate a README.md file for your projects

Project description

generate_Readme

The readme_generator is a command-line interface (CLI) tool written in Python that generates a README.md file for your project. It automatically creates a well-formatted and structured README.md file based on the information you provide about your project.

Dependencies

Markdown argparse

Usage

readme_generator.py [-h] --project-name PROJECT_NAME --description DESCRIPTION --installation INSTALLATION --usage USAGE --contribution CONTRIBUTION --contact CONTACT

all arguments are required: --project-name, --description, --installation, --usage, --contribution, --contact

Support

kindly consider starring the project

Screenshot

image

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

generate_readme-0.1-py3-none-any.whl (2.6 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