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

If you're not sure about the file name format, learn more about wheel file names.

generate_readme-0.1-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file generate_readme-0.1-py3-none-any.whl.

File metadata

  • Download URL: generate_readme-0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for generate_readme-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d7d211536a08e6e35260a6d533e6cb2329eb5b3461f8151a01b7b4358d6d02c9
MD5 2763f782e6e301a1b236089a4d0184f5
BLAKE2b-256 04e03721a47b6482e61ebc7d1cb943fcb1ac3f6f74f9eff181f1ac8add6f8920

See more details on using hashes here.

Supported by

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