Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 4.25 KB

README.md

File metadata and controls

95 lines (73 loc) · 4.25 KB
Raw

README Gen Pro

GitHub repo size GitHub code size GitHub language count GitHub top language

GitHub last commit GitHub closed pull requests GitHub open pull requests GitHub closed issues GitHub open issues

GitHub stars GitHub forks GitHub watchers GitHub followers

GitHub version

License: MIT

Description

README Gen Pro is a command-line application that dynamically generates a professional README.md file from a user's input using the inquirer.js package. (This README.md file was generated using this app!)

Table of Contents

Deployment URL

This is a command-line application. It is not deployed online.

Repo URL

https://github.com/ahmadelgamal/README-Gen-Pro

Features

  1. This is an easy to use command-line application.
  2. It uses the inquirer module to ask the user a series of questions.
  3. The answers are used to automatically generate a README.md file in an output directory.

Pre-Requisites

  1. Install node.js.

Installation

  1. Download or Clone this repository.
  2. If you downloaded the zipped version of this repo, then unzip it in the desired directory.
  3. Go to the command line (if you're not there already).
  4. Change the directory to README-Gen-Pro-main (or README-Gen-Pro depending on the name of the installed directory).
  5. Run: npm install to install the inquirer module.

Usage

  1. Go to the command line.
  2. Navigate to the app directory.
  3. Run node index.js (or npm start).
  4. Answer the question prompts.
  5. Once completed, check the output folder for the README.md file.
  6. If you chose to add a gif animation or png screenshot file, then either add it to a ./assets/images folder in your app, or change the relative path in the README.md file to point to the corresponding folder.

Screenshot / Gif Animation

Screenshot / Gif Animation

Video Demo

Video Link

Technologies Used

  1. JavaScript
  2. Node.js
  3. Inquirer.js
  4. Markdown

Tests

  1. Run the command npm test to generate a sample README.md from sample answers saved in the object in the sample-answers.js file in the __test__ directory.
  2. You can change the generated README.md values by changing the values of the object in the sample-answers.js file.

Roadmap

  1. Add more license options.
  2. Add autocomplete.
  3. Add trim() to user input.

Questions

Please send your questions and / or comments to Ahmad El Gamal at [email protected], or contact me on GitHub.

License

This project is licensed under the terms of the MIT license.