makereadme
| Crates.io | makereadme |
| lib.rs | makereadme |
| version | 0.3.0 |
| source | src |
| created_at | 2023-02-27 00:11:57.485122 |
| updated_at | 2023-06-10 21:29:09.680721 |
| description | A simple CLI made to create a README.md for your repository |
| homepage | https://github.com/caio-bernardo/MakeReadme |
| repository | https://github.com/caio-bernardo/MakeReadme |
| max_upload_size | |
| id | 795585 |
| size | 51,431 |
Caio Bernardo (caio-bernardo)
documentation
README
MakeReadMe
A CLI for creating a README for your github project
Table of Contents
About The Project
This project aims to automate part of the coding workflow by helping you to quickly generate a good looking README. You answer the questions, we write the boilerplate for you.
Built With
Getting Started
This is section will teach you how to set up and run the program
Prerequisites
For now, you will need cargo and rust installed on your system.
curl https://sh.rustup.rs -sSf | sh
Eventually, a non-cargo installation method will be provided.
Installation
Just cargo install the application and you are good to go.
cargo install makereadme
Usage
The README.md will be created on your current directory. Just run
makereadme
Answer the prompts and your README.md will be ready for you to give some final touch.
Roadmap
- Full test coverage
- Environment analysis and completions
- Better performance and binary size
- Better error handling
- Documentation with Examples
- More templating options and allow customization
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Take a look at CODE OF CONDUCT and CONTRIBUTING for more info.
License
Distributed under the MIT License. See LICENSE for more information.