IndieCoderMM/readme-generator

Awesome project readme generator

Table of Contents

• 📃 Readme Generator
  • 🧰 Tech Stack
  • ✨ Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Usage
    • Run tests
  • 👨‍🚀 Author
  • 🎯 Future Features
  • 🤝 Contribution
  • 💖 Show Your Support
  • 📜 License

📃 Readme Generator

A simple console app that can generate awesome readme file for your projects

(back to top)

🧰 Tech Stack

• Ruby
• ERB
• Rubocop

(back to top)

✨ Key Features

• Generate readme quickly
• Simple, easy-to-use
• Command line interface

(back to top)

💻 Getting Started

To run this project locally, follow these steps.

Prerequisites

In order to run this project you need Ruby installed on your machine.

Setup

Clone this repository to your desired foler.

cd my-project
git clone git@github.com:IndieCoderMM/readme-generator.git .

Installation

Intall this project with:

gem install

Usage

To run the project, execute the following command:

ruby main.rb

Run tests

To run tests, run the following command:

rspec spec

(back to top)

👨‍🚀 Author

I am always looking for ways to improve my project. If you have any suggestions or ideas, I would love to hear from you.

Hein Thant

(back to top)

🎯 Future Features

• Improve template
• Organize code

(back to top)

🤝 Contribution

Contributions, issues, and feature requests are welcome!

(back to top)

💖 Show Your Support

If you like this project, please consider giving it a ⭐.

(back to top)

📜 License

This project is MIT licensed.

(back to top)

This readme is generated by readme-generator