To avoid writing an entire README from scratch for each project, this markdown generator lays out a template and takes user input for project specifics to make a README in no time. Bypass the hassle of searching for your license badge, or writing the same contact instructions with each repo, and only enter the specifics to obtain the perfect README for your project.
To install necessary dependencies, run the following command:
npm i inquirer --save
When node.js is installed and the path is set to the Good-README-Generator folder in the terminal, run the index.js file by typing node index.js
. Answer each prompt with the specifics to your project.
Readme-Generator.mp4
This project is licensed under the terms of the MIT License.
I am the sole author of this repo and I am not currently looking for contributors. If you find an error, please make an issue or contact me directly.
This application does not have any tests.
If you have any questions about the repo, open an issue or contact me directly at Gaitherdb@gmail.com. You can find more of my work at Gaitherdb.