Skip to content

The objective of this command-line application is to generate a professional README for the user.

Notifications You must be signed in to change notification settings

pazjenni04/README-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README-GENERATOR

Table of Contents

  1. Description
  2. Usage
  3. Technologies
  4. Questions
  5. Link
  6. License

Description

The objective of this application is to create a professional readme for the user.

Usage

To use this application, the user first needs to git clone https://github.com/pazjenni04/README-generator.git into their terminal. Once they have cloned the repo, the user then needs to install the inquirer package by first typing in

npm init -y

and then typing in

npm i inquirer

This will then download the inquirer package and create a package.json and a package-lock.json.

Once the inquirer package has been downloaded, then the user will need to open a 'New Terminal' in their visual studio code and type in node script.js. Once the user presses enter, they will then be prompted with the first question.

This image is a screenshot of the first question the user is prompted.

Once the user responds to the question, they will then be prompted with the next series of questions that will complete the major sections of a professional README file. If the user attempts to bypass a question, they will be prompted with a message saying that a response is needed to proceed.

This image is an example of the message the user is prompted with if they attempt to proceed without responding to the question.

Once the user answers all the questions, then a "Success!" message will be prompted within the terminal a new readme file will then be created.

Technologies

  • JavaScript, node.js, and inquirer package

Questions

Questions? Feel free to contact me.

Links

To see a demonstration of this application, feel free to watch the following link. https://youtu.be/dJ63_K8adxU

License

License: MIT

About

The objective of this command-line application is to generate a professional README for the user.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published