MakeReadMe

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MITLicense][license-shield]][license-url]

A CLI for creating a README for your github project

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments
## 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.

(back to top)

### Built With - [Clap](https://github.com/clap-rs/clap) - [Inquire](https://github.com/mikaelmello/inquire) - [Handlebars Rust](https://github.com/sunng87/handlebars-rust) - [And more...](/Cargo.toml)

(back to top)

## 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. ```sh 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. ````sh cargo install makereadme ``````

(back to top)

## Usage The README.md will be created on your current directory. Just run ```sh makereadme ``` Answer the prompts and your README.md will be ready for you to give some final touch.

(back to top)

## 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](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).

(back to top)

## 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](/CODE_OF_CONDUCT.md) and [CONTRIBUTING](/CONTRIBUTING.md) for more info.

(back to top)

## License Distributed under the MIT License. See [LICENSE](/LICENSE) for more information.

(back to top)

## Acknowledgments - [readme-md-generator](https://github.com/kefranabg/readme-md-generator) - [Best-README-Template](https://github.com/othneildrew/Best-README-Template) - [ReadME-Generator](https://github.com/ShaanCoding/ReadME-Generator)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/caio-bernardo/MakeReadme.svg?style=for-the-badge [contributors-url]: https://github.com/caio-bernardo/MakeReadme/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/caio-bernardo/MakeReadme.svg?style=for-the-badge [forks-url]: https://github.com/caio-bernardo/MakeReadme/network/members [stars-shield]: https://img.shields.io/github/stars/caio-bernardo/MakeReadme.svg?style=for-the-badge [stars-url]: https://github.com/caio-bernardo/MakeReadme/stargazers [issues-shield]: https://img.shields.io/github/issues/caio-bernardo/MakeReadme.svg?style=for-the-badge [issues-url]: https://github.com/caio-bernardo/MakeReadme/issues [license-shield]: https://img.shields.io/github/license/caio-bernardo/MakeReadme.svg?style=for-the-badge [license-url]: https://github.com/caio-bernardo/MakeReadme/blob/master/LICENSE