The readme-generator is a command line interface program that generates a high quality README.md file for your projects. Simply running the program begins a series of prompts that ask questions pertaining to your project. As you answer the questions, the questions are saved as an object after which these answers are used to generate a README.md file. This file can then be used for your project!
To install the project simply clone the repository from github. You will also need to make sure tha Node.js is installed on your computer so you can run this program. With the repo cloned, navigate to the repo directory in the terminal and be sure to run 'npm install inquirer' to use the inquirer feature in this project. Once you have done this then you are ready to run the program!
This project's intended use is for anyone looking for a README.md file to be generated. If you have 1 or multiple projects that need README.md files then this project can help deliver README.md files quickly and consistently.
How to run the readme-generator
If you have any questions about the project listed here or myself in general please contact me at alexdmarten@gmail.com. I will get back to you as soon as possible, thanks!
Interested in any of my other projects? Check out my github alex-d-marten