- Link to GitHub repository: https://github.com/Tzcodes101/readMeGenerator
- Link to animation of use: https://drive.google.com/file/d/1vKyXeOpyiaUAXbl8Atxy7ZrZR89uj7a0/view
This project provides a command line interface for a user to create a good README. A user can focus on creating a project rather than spending time working on the README. The project enables a user to provide a title, a description, instructions for installation and use, contributors, test instructions, an area for questions, and GitHub/e-mail contact information. This information is added to an approriate section within the README. A table of contents is provided, and when a user clicks on the links in the Table of Contents, a user is taken to the corresponding section of the README. Also, when a user chooses a license from a list of options, a badge is added to the top of the page, as well as a notice that explains which license the application is covered under.
To install, a user must clone the code for the project from it's GitHub repository (https://github.com/Tzcodes101/readMeGenerator) to their local workspace. The user must then run npm install inquirer. A user must also have node.js installed and working on their computer.
To use this project, a user must open index.js in an integrated terminal. The user can then run node index.js, answering the questions in the terminal. Once all questions are complete, a new file, titled README.md, will appear, and can be viewed in preview.
This project is not covered by any license.
- Talia Zisman
This project can be tested by following the usage instructions.
Please e-mail the creator, Talia Zisman, of this application with any questions.
- E-mail: tzcodes101@gmail.com
- GitHub: tzcodes101