Zakaria1986 / Github-README.md-Generator

This app will auto generate README.md file by taking the developer through series of question.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auto generate README.md file from console.

Description

When we developers work on any given project, we sure do spend lot of time working about what to write and how to layout the structure of our readme.md file. Well this app created to ease that struggle and save developer/your precious time. With that in mind, this app take you through series of questions which you fill in the readme.md file gets generated in your root-folder automatically. I hope you find this app useful. See installation guide section to get you started. Good luck!

Table of Contents

  1. Description

  2. Installation

  3. Usage info

  4. License

  5. Contributors

  6. Tester info

  7. Further Q&A

  8. GitHub Link

    Instalation

To run this app, make sure you have node installed on your machine then go to you project root folder then run: 1. npm init, 2. Install inquirer, fs, and axios.

Usage

When the app is run, you get series of questions related tot he project. You fill the section which then gets processed and then the application generates readme.md file which then can be pushed to your live git repo.

Walk through link:

License

License: MIT

Contributor

If you would like to contribute to this project, please get in touch on email

Tests

If you would like to test and contribute to this app, please download a copy of the repo and let me know the bug or anythings. Thank you!

Further Q&A

If you have any further question, please get in touch on: email

Git Profile Name

Click to see git repository

About

This app will auto generate README.md file by taking the developer through series of question.


Languages

Language:JavaScript 100.0%