[MITLicense] (https://img.shields.io/badge/licenses/MIT)(https://opensource.org/licenses/)
I was tasked to create a professional README generator that would allow developers to answer a series of questions about their application. Their answers to the questions would then be returned in a README markdown, ensuring that they had a comprehensive README file for their application, which conformed to best practices.
-
Firstly fork and clone this repo to your personal GitHub. Follow these instructions to fork and clone this repo.
-
Secondly, open the cloned repo in VS Code.
-
Open the integrated terminal by right clicking on the index.js file in VS Code and clicking 'Open in Integrated Terminal'.
-
Finally type 'npm install inquirer' into your integrated terminal to install the inquirer package. The inquirer package is used to generate the series of questions that will allow you to input answers about your application. Your inputted answers are used to generate your README.
Once you are ready to input the content to generate your README, open the index.js file in the integrated terminal and type npm run start. You will then be presented with a series of questions about your application. Please try and answer all questions and do not simply hit return to skip to the next question. Each question has an input validation on it and therefore it will not accept empty strings.
If the question is not relevant, please type 'not applicable' to proceed to the next question.
Once you have answered all questions, you will see that your new README has been generated in your VS Code folder under the file name 'generated_readme.md'.
No applicable tests.
Simply fork and clone my repo as outlined above, or email me for any bespoke queries: gemmacollinge_71@hotmail.com
https://drive.google.com/file/d/1f1wYxOOfyBdIxZY_g37oC11ngaEuKoii/view?usp=sharing