AS A developer
I WANT a README generator
SO THAT I can quickly create a professional README for a new project
This is a command-line application that users can quickly and easily create a README file by inputting their project information, which allows the users to devote more time to working on the project.
Once the user input information about their projects, then a readme file is generated with the title of my project and sections including Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.
To generate your own README using this application:
- run
npm init
- run
npm install inquirer
The application can be invoked with node index.js
You can find example readme file generated by this application here
-
The URL of a video that shows a typical user flow: https://drive.google.com/file/d/1fXjoYnDFFvzFhK8LNOqbaes6VngdEWNI/
-
The URLs of the GitHub repositories: https://github.com/mengyue-z/Professional-README-Generator