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
• Inquire
• Handlebars Rust
• And more...

(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.

  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

(back to top)

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.

(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 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 and CONTRIBUTING for more info.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

• readme-md-generator
• Best-README-Template
• ReadME-Generator

(back to top)