[Linkedin:] (https://www.linkedin.com/in/hrishikesh-kanabar-b7127365/)
[Github:] (https://github.com/HrishikeshKanabar)
1.) You will asked few question regarding content you want include in "README" file
2.) Some questions are mandotory are marked as "Required"
3.) Once you answer all questions read me will generated as per response of your question
4.) You will find readme in "Develop/generatedReadme" folder.
5.) You can preview readme if you use VS code , use shift + ctrl + v
Web Application |
---|
Genrated Readme |
---|
GIVEN a command-line application that accepts user input
WHEN I am prompted for information about my application repository THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions
WHEN I enter my project title THEN this is displayed as the title of the README
WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests
WHEN I choose a license for my application from a list of options THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under
WHEN I enter my GitHub username THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile
WHEN I enter my email address THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions
WHEN I click on the links in the Table of Contents THEN I am taken to the corresponding section of the README
Deliverables: 20%
Walkthrough Video: 27%
Technical Acceptance Criteria: 40%
Repository Quality: 13%
Step-1 git clone https://github.com/HrishikeshKanabar/Auto-ReadMe-Generator.git
Step-2 open folder in VS Code
Step-3 Install extension "open in browser"
Step-4 Change directory to "Develop" (Cd Develop).
Step-5 Run node index.js in terminal.