A cli tool to interactively generate a README file

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for AnH0ang from gravatar.com AnH0ang

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: An Hoang
  • Tags cli, readme, mkreadme
  • Requires: Python >=3.8, <4
Classifiers

Project description

mkreadme

PyPI version Python version Release Pipeline Code Quality License: MIT pre-commit

📝 Description

mkreadme is a cli tool for interactive creation of a README.md file. It was inspired by readme.so. You can choose from different README sections, which are then merged into a complete document.

⚙️ Installation

Install mkreadme with pip

  pip install mkreadme

💡 Usage Examples

To interactively create a README file with mkreadme, run

mkreadme --filename README.md

🖼️ Screenshots

App Screenshot

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for AnH0ang from gravatar.com AnH0ang

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: An Hoang
  • Tags cli, readme, mkreadme
  • Requires: Python >=3.8, <4
Classifiers

Release history Release notifications | RSS feed

This version

0.4.0

0.3.0

0.2.0

Download files

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

Source Distribution

mkreadme-0.4.0.tar.gz (5.0 kB view hashes)

Uploaded Source

Built Distribution

mkreadme-0.4.0-py3-none-any.whl (5.5 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