Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voilalex/readme-cli
https://github.com/voilalex/readme-cli
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/voilalex/readme-cli
- Owner: VoIlAlex
- License: mit
- Created: 2020-04-14T17:36:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-03T16:39:35.000Z (over 1 year ago)
- Last Synced: 2024-10-29T01:10:33.187Z (3 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# README CLI
Simple README.md generator.
## Installation
To install type the following in the terminal:
```bash
pip install readme-cli
```
## Usage
Command to generate LICENSE.md file looks like:
```bash
readme
```
Or you can specify a variant of the generated README.md:
```bash
readme
```
Where `` is one of:
* **small** - title, installation, usage
* **medium** - title, installation, usage, license, contributing
* **large** - lots of stuff
## License
[MIT](LICENSE.md)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)