/ReadMe-Generator

Generates a professional read me from the command line

Primary LanguageJavaScript

ReadMe-Generator

Generates a professional read me from the command line

Technologies used

In this program, we use node.js and its inquirer package to create a very useful readMe generator.

Installation.

To run this program, you must install the required packages from npm. Here is a step-by-step guide.

  1. Navigate to the correct folder/workspace that includes the correct package.json file.
  2. From you command line, gitbash, or terminal, invoke npm install and you should have to correct node modules.
  3. Now that you have the required dependancies, you are ready to begin the application.
  4. In your command line, run index.js to start.

User Story

Upon launching the application, the user will be prompted, from the command line, questions that retain the the content of the readMe file to generated. The user will have to enter information such as Testing information and Contribution Guidelines Once the user has completed all the questions, a .md file shall have been created in the same folder.

Video Demonstration Link

ReadMe Demonstration