Skip to content

mkreadme is a cli tool for interactive creation of a README file

License

Notifications You must be signed in to change notification settings

AnH0ang/mkreadme

Repository files navigation

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