Simple README.md generator.
Project description
README CLI
Simple README.md generator.
Installation
To install type the following in the terminal:
pip install readme-cli
Usage
Command to generate LICENSE.md file looks like:
readme
Or you can specify a variant of the generated README.md:
readme <readme-variant>
Where <readme-variant> is one of:
- small - title, installation, usage
- medium - title, installation, usage, license, contributing
- large - lots of stuff
License
Contributing
See CONTRIBUTING.md
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
readme-cli-1.0.1.tar.gz
(3.8 kB
view details)
File details
Details for the file readme-cli-1.0.1.tar.gz.
File metadata
- Download URL: readme-cli-1.0.1.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9aa23d4ff6d5a8b775dc01802a3f8072c6c9d94bdbe83420f117c61e0bf1b137 |
|
| MD5 | a3988d96a4a09be13110cb413a339d68 |
|
| BLAKE2b-256 | ecc37b3302882781b43ca1212e73f68a11972575d3b24696363ca15b2676457e |
