ReadmeGen was created to help simplify one of the most vital aspects of development; README documentation. Using Node.js and Inquirer, ReadmeGen uses a short battery of questions to fill out and format a concisely written README file.
To install, download or clone this repository to your machine. once done, install inquirer via NPM. Note that this program requires node.js installed to work.
With all dependencies installed, run the script.js file in a Node.js enabled terminal instance, answer the prompts, and move the resulting file from the output folder into your project repository.
I'm immensely grateful for the guidance and knowledge of my instructors at the Columbia Engineering Coding Bootcamp. I would also like to thank my study gruop, whose peer review and feedback were vital to the completion of this project.
Contributions to this project are governed by the Contributor Covenent.
Questions about this project can be directed to:
- Github: /puentebravo
- Email: puentematos@gmail.com
N/A
Content in this project is governed under the MIT License.
To read the license in its entirety, click here: MIT
Copyright [2021] [Charlie Puente]