This is a A node.js application that uses user input from inquirer to populate a README.md file for user repository. It will help a user crate the README structure without having to worry about applying proper mark down syntax. The app starts with the user being given a welcome message. And then the user is walked through a set of questions that requires their input including Description, Installation, Usage, Contributing, and Tests. The user is also presented with the license options which they can choose from five of the most popular open-source licenses. After choosing a license a the respective license badge will be at the top of the README and a license section with text stating what license was chosen will be created. Lastly, user can input their email and github link which will appears in the questions section. After complete all the prompts, the README will generated with a message saying ' WooHoo! Your README.md file has been generated in the sample folder. '
Save yourself time by using this professional README Generator that will create a README.md file for you! Simply follow the directions below for information on how to use.
Link to the demo video: https://drive.google.com/file/d/1EM14n-s-365IvqGnyk_CqXUtl_tz5zt5/view.
This is a sample README page generated using this application
Below is the video showing the functionality of the application:
README.GENERATOR.mp4
- Step 1 : open terminal
- Step 2 :clone the repo
- Step 3 :cd into new directory (Must be in directory to work)
- Step 4 :Initiate the npm by entering
npm init - Step 5 :Download Inquirer package by entering
npm install inquirer - Step 6 :Enter
node index.js - Step 6 :Follow the prompt
Answer the prompt questions: click enter to move to the next question.
What's the Projects Title?
Write a brief description of your project:
Enter your projects installation instructions:
Enter usage of the project:
Chose the appropriate license for this project: List of licenses
Who are the contributors of this projects?
Please provide instructions on how to test the app.
Please enter your GitHub username:
Please enter your email:
If you would like to contribute to this project reach out to me. Contact Information can be found below or by clicking on the Questions link provided in the Table of Contents.
To test this app, open up the file in VS Code. Open the terminal and run node index.js. Answer the prompts and view the preview of the generatedREADME.mdfile in the sample folder.
📩 If you have any question, email me here at : lihexuan1@gmail.com
My Github page is siennameow