Skip to content

This application leverages the command line, Node.js, and the Inquirer.js library to interactively gather project details from the user. It prompts for essential information like project description, installation instructions, contributors, and more. After gathering responses, it generates a well-structured README.md file with a Table of Contents,

Notifications You must be signed in to change notification settings

tlaze/ReadMeGenerator

Repository files navigation

badge

ReadMeGenerator

Table Of Contents

Description

This application uses the command line, node.js, and the inquirer dependency to ask the user a series of questions about their project. Questions include describing their project, what is needed to be installed to use the application, who contributed to the project, and more! Once the user answers the questions, a README.md file is created. The file has proper syntax and includes a Table of Contents, as well as links to which License was used. This application is versatile and able to be customized for any project.

Installation

To run this application properly, you need to install node.js, npm, and inquirer dependency

Usage

Clone the project to your Desktop. Open the command line and navigate to the project folder. Enter the command npm i followed by node index.js.

License

This Project is licensed by MIT.

Contributors

The following helped make this project possible:

Tom Lazore - Contact Info Below

Tests

To test this application, enter You can test validation while answering questions in the command line

ScreenShot

Screenshot

Links

Live application: No Live Application for this project. However you can follow this Google Drive link to watch a demo of the generator. https://drive.google.com/file/d/1_ZqUhzZmQ9EZRSOvzgRUSOAWJNwdC07B/view?usp=sharing

Project Repository: https://github.com/tlaze/ReadMeGenerator

Questions

If you have any questions, comments, or issues feel free to contact Tom Lazore directly through

email: [email protected]

or check out my GitHub

About

This application leverages the command line, Node.js, and the Inquirer.js library to interactively gather project details from the user. It prompts for essential information like project description, installation instructions, contributors, and more. After gathering responses, it generates a well-structured README.md file with a Table of Contents,

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published