A command line application designed to speed up the readme file creation process.
Livelink: <- Tutorial video will be placed here.
To install this application, you may download the code into a zip file, or clone the repository. If you do not know how to clone a repository, I suggest looking into this GitHub Documentation.
This command line application requires inquirer, which can be installed using the terminal prompt "npm install inquirer". To run the terminal command, one must also have Node.js, which can be installed here (for those new to coding, it is recommended to install the LTS version of node.)
After dependencies have been installed, open up the main terminal for the project folder and run "node index.js". This will prompt the user with a series of questions that will fill in the generateMarkdown.js file. The generated readme will be created as "genREADME.md".
Feel free to contact me using the information below if you have any questions or feedback!
Name: Jacob(Jake) Beeson
Portfolio
Github
Email: boxnbeeson.jp@gmail.com
Understanding Node.js:
Node.js Documentation
Writing Files in Node.js
Markdown help:
Markdownguide cheatsheet
How to write a table of contents
Mastering Markdown
How I created my "Table of Contents" footnote
Licenses:
https://choosealicense.com/
Inquirer:
Inquirer Documentation
MIT