https://iescandon.github.io/good-readme-generator/
This application is designed to function as a ReadMe generator. The user utilizes a CLI (terminal or gitbash) to create a good ReadMe. It includes all the basic sections as well as extra features such as a table of contents and a license badges. License link and badges get adjusted according to the users choice. The user is prompted to fill in these sections via their CLI and the ReadMe will be created within this repository.
In order to install this project, you must login to GitHub and go to github.com/iescandon/good-readme-generator. Once there you will click on the green button that says clone or download. You will be given choices on how to download: using the ssh/html key or downloading the zip file.
Using SSH/HTML Key: You will copy the link shown and open up either terminal (mac: pre-installed) or gitbash (pc: must be installed). Once the application is open, you will type git clone paste url here. Once you have cloned the git good-readme-generator repo, cd into the repo and type "open ." to open the folder which contains all files used for the website. Once inside the folder, click on index.html to open the website in the browser.
Using Download ZIP: Click on Download Zip. Locate the file and double click it to unzip the file. Locate the unzipped folder and and open it. All the files for the website will be within this folder. Click on index.html to open the website in the browser.
In order to use this application. You must cd into the good-readme-generator respository via your CLI. Once there, you will need to type in 'npm install' in order to install inquirer. If inquirer does not get installed, the prompts will not work. After that is installed, you type in 'node index.js' to initialize the questions. Answer the following prompts and the good ReadMe file should be created in the good-readme-generator repository.
Copyright (c) [2020][inezescandon] The license is MIT License. Read more about it at https://opensource.org/licenses/MIT.
Used classroom activities for code inspiration.
No tests available for this application.
If you have any additional questions please contact me at iescan4@gmail.com. GitHub: https://github.com/iescandon