README-Generator

📖 README Generator

## License

## Description

This command-line application prompts the user to fill in information about each section in a README file. A professional, high-quality README file will then be generated after the user answers each question. A README file has already been outlined making the process of creating a README for any project more efficient therefore allowing more time and dedication to the project at hand.

## Table of Contents

• Links
• Installation
• Usage
• Contribution Guidelines
• Tests
• Questions
• Screenshots

## Links

• GitHub Repository Link: https://github.com/LinnetteCapul/README-Generator

• Application Link: https://linnettecapul.github.io/README-Generator/

• Demonstration Video: https://drive.google.com/file/d/1PZr9TyO0hzU3ydA0lRfzbMolgbejJtaZ/view?usp=sharing

## Installation

To use this application, make sure to git clone the repo. If haven’t done so already, ensure that npm install has been completed to access inquirer from package.json. To start the application, run node index.js in the command line of the terminal. This will prompt the user questions to answer and generate a README file when all questions have been completed. The generated README file can be found in the root of the repo for easy access.

## Usage

When the user runs node index.js, the application will prompt the user questions in the command line to fill out each section of a standard README file. This application can be used to save time on creating a README from scratch and more time spent on the project itself.

## Contribution Guidelines

For details on how to contribute to this project, please reach out to the original creator of the project. Contact information can be found under “Questions?” section.

## Tests

No test provided at this time.

## Questions?

Please contact me at either of the following for any inquiries about the project.

• GitHub Profile: LinnetteCapul
• Email: linnette.capul@gmail.com

## Screenshots

Demonstration of README Generator application being used with questions prompted in terminal and ability to fill in the corresponding information to project.

Generated README file in preview viewing showing user’s responses to the corresponding sections.