Readme Generator

This project is a markdown generator for your repository.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This project is a command-line application that dynamically generates a professional README.md file from a user's input.

You can quickly and easily create a README file by using a command-line application to generate one.

It allows the project creator to devote more time to working on the project.

(back to top)

Built With:

• 

(back to top)

Getting Started

Prerequisites

You must have node.js installed on your computer to install this application.

Installation

1. Clone the repo

git clone https://github.com/fl4viooliveira/readme-generator.git
cd readme-generator

2. Install NPM packages

npm install

3. Execute index.js

node index.js

4. Answer the questions.

(back to top)

Usage Video

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch ( git checkout -b feature/AmazingFeature )
3. Commit your Changes ( git commit -m 'Add some AmazingFeature' )
4. Push to the Branch ( git push origin feature/AmazingFeature )
5. Open a Pull Request

(back to top)

License

Distributed under the .

Contact to Questions

Send your Questions about the project:

• Flavio Oliveira - fl4viooliveira@gmail.com

• GitHub Link: github.com/fl4viooliveira

(back to top)

This file was generated by Readme Generator.