This is a simple, good quality README Generator for all future projects. Created using JavaScript and Nodejs. This is run at the command line, prompting the user to answer a series of questions generating a README file in markdown format.
See below a brief demo of the application:
The view the full resolution video, please view from this link.
1.) Ensure that you have dependencies such as node.js already installed.
2.) Clone the code repository to your local machine.
3.) Navigate to the root of the project folder that you've just cloned.
4.) Run npm i either on git bash or on the integrated terminal to install all required node modules required.
To run the program, type node index.js into the terminal. You'll be faced with a series of questions to answer.
This project is licensed under the MIT license. Click the below badge for further information.
N/A
As part of testing and making sure the application runs correctly, I have pathed the generated README files to be generated within the testing-folder rather than the root. Once you are happy with the README file, feel free to move it to the root. This is done so that it doesn't overwrite an already existing README file in the root of the project folder.
For any questions relating to the project, please feel free to get in touch with me via email at: aaronarmstrong1490@gmail.com Feel free to also check out my GitHub profile and follow along at: aaron1490