Esztergb / readme-generator

Readme Generator

Description

This app generates a comprehensive README file based on user input.

Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Questions

Installation

Before attempting to use this project, make sure to have these programs installed on your computer:

• VS Code
• GitBash
• Node.js

Steps to initialize the project:

1. Copy Link: Hit the "Code" button within this GitHub repo to copy link
2. Clone: Within GitBash, use the command "git clone paste link here"
3. NPM: Use the command "npm init -y" to install Node Package Manager
4. Inquirer: Use the command "npm install inquirer" to get npm's inquirer package

Usage

The application will be invoked by using the “node index” command.
Click on the screenshot below to start the Screencastify video tutorial:

License

This project is covered under the MIT licence.
To learn more click on the following link

How to Contribute

Please follow Contributor Covenant Guidelines by clicking on the following link: Contributor Covenant

Tests

Simply use the application

Questions

If you have any questions about this projects, please email me: [e-mail] directly.
Please visit my GitHub Page to view more of my projects.

Credits

Thank you for tips and sugestions from Bootcamp instructors and classmates. I have used https://www.w3schools.com/ and https://www.stackoverflow.com to research information. Did not work with tutor this week. Codes were based on mini project mainly and some other modules from bootcamp.