A cli tool to interactively generate a README file
Project description
mkreadme
📝 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkreadme-0.4.0.tar.gz.
File metadata
- Download URL: mkreadme-0.4.0.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.14 CPython/3.8.9 Linux/5.15.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b350afdbbbb5ebd8f11984bdde740d5eeda8e7fe544be9a797dcd598c630a5e1
|
|
| MD5 |
978056f58f176d130297e7cfdd3c3e10
|
|
| BLAKE2b-256 |
27bcd7fe35fc3b24895cba78ea6c86a326759f67de6fc04555737eec8c1b750b
|
File details
Details for the file mkreadme-0.4.0-py3-none-any.whl.
File metadata
- Download URL: mkreadme-0.4.0-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.14 CPython/3.8.9 Linux/5.15.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0259198bef28d9c22d20fb3b0c815b2284cf89cca579731a3cf32713c7494820
|
|
| MD5 |
8faf43eb237afd7b01d81690e30f7cad
|
|
| BLAKE2b-256 |
a86b444bee6882a76d4e4d4312bf77bf14c9aad49935da3c51dc3991444ee2d8
|
