The user will be asked to enter information for a README file and then the program will generate a README with the given information. This makes it easier for the user to document their work.
Download code from the GitHub repository. Have Node.js installed. Link to Node.js downloads: https://nodejs.dev/en/download/. In a terminal input npm init -y. Then in the terminal install inquirer version 8.2.4 by inputting npm install inquirer@8.2.4.
Generate a README file by answering a series of prompts. It will display in order the project title, description, table of contents, installation, usage, license, contributing, tests, and questions.
To run the program, in a terminal input node index and then the prompts will appear. Type an answer (unless told otherwise) and hit enter to continue to next prompt. If the user does not want to fill out a prompt it can be left empty. Once all the prompts are done, the terminal will say "Succsess!". The README will be generated in the assets folder as REAME.md (not to be confused with this README). The user can use this program at any time, but the previous README will be overwritten.
If the title is left blank, the title will have placeholder. If a section is left blank, then it will not appear on the generated README nor will it appear on the table of contents section. The table of contents section will have a link to the respective sections for quick access.
The user is asked a yes or no question if they want to add a photo. If yes, they will be asked to enter the file name and the photo description. If file name is left blank, the photo will be a placeholder. The photo description will be defaulted to "screenshot" if the description is left blank. The photo will try to refer to the assets/images folder. The photo will not properly appear if the file does not exist in that folder or if the file does not have a valid photo type (png, jpeg, etc). The photo will not appear in the generated file if it is still in the assets folder. It will appear once the generated README is moved to the main folder of any repository. The photo will appear in the usage section regardless if the user entered anything for usage. If there is usage information, the photo will go after.
The license prompt is asked as a list. The list contains all the licenses that GitHub presents. The list is long, so the user may need to scroll down to find the right one. Inquirer also loops the list when it is long. There is an option for no license, but it is not recomended. The section will show the license name and then a badge that will link to the license's website. The website should provide the user with further information about the license. The badge is generated by https://shields.io/. The badge also appears at the top of the README for quick visibility.
The questions section is comprised of the user's github profile and their email. This section serves as a contact me.
Screenshot of application:
Video: https://drive.google.com/file/d/16UsS_FniTQRbnwE48tuWLAxVdqReyYN6/view
MIT License
Node.js (download here: https://nodejs.dev/en/download/)
Badge generator: https://shields.io/
Guidance on README format: https://coding-boot-camp.github.io/full-stack/github/professional-readme-guide
N/A
GitHub profile: https://github.com/CYMcolor