ReadMe Generator

Table of Contents

• Description
• Installation
• Test Instructions
• Demo
• License
• Contact

Project Description

This project utilizes nodejs to generate a readme with a set template that is filled with the users answers to the prompts asked.

Installation

Tools Needed:

1. Terminal (MacOS) or GitBash (Windows)
2. Have a Github account (Not Required)
3. Install text editor of your choice (e.g. VSCode, Atom, etc.)
4. Install NodeJS

How to view the project:

1. Navigate in terminal/gitbash where you want to save the project
2. Clone the project via HTTPS or SSH link found in my GitHub repo https://github.com/plotinusspascual/readme-generator
3. After entering the command 'git clone [HTTPS/SSH Link]' in terminal, use command 'code .' to open the project in your default text editor
4. Change directory so you are inside the readme-generator folder
5. Once inside the working folder, use terminal command "node index.js"

Test Instructions

• After using terminal command "node index.js" answer all the prompts
• You will see "Success!" printed once you finish all the prompts
• A file called "generatedREADME.md" is made inside the working folder
• Copy and Paste the content inside that file into your README file
• You now have a generated README

Walkthrough Video

• Walkthrough Video

Screenshots

Terminal Prompts

Output Results

License

Unlicense

Github

• Link to Github

Questions

If you have anyquestions please feel free to email me

• plotinusspascual@gmail.com

© 2021 Trilogy Education Services, LLC, a 2U, Inc. brand. Confidential and Proprietary. All Rights Reserved.