What to include in a professional README file
Welcome to the ReadMe Generator! This is a command-line application that runs locally and accepts user input when prompted for information about an application repository. At the end of the series of prompts, a high-quality, professional README.md is generated with the title of the project and different sections ( Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions).
When you enter the project title, this is displayed as the title of the README.md. After entering a description, installation instructions, usage information, contribution guidelines, and test instructions, this is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests. You can then choose a license for my application from a list of options and a badge for that license is added near the top of the README and a notice is added to the section of the README entitled "License" that explains which license the application is covered under.
Enter your GitHub username to add to the section of the README entitled Questions, with a link to your GitHub profile. You will also enter your email address to be added to the section of the README entitled "Questions," with instructions on how to contact you with additional questions.
Clicking on the links in the Table of Contents takes you to the corresponding section of the README.
- Installation
- Usage
- Features
- Contribute
- Tests
- Video Walkthrough Demonstration
- Contribute
- Questions
- Credits
If you would like to use this program, download this repository. After downloading, open the app through a Javascript reader - in the attached video I walk through using Node.js. From the Node.js terminal, run the program by typing "Node index.js". From here you will answer a series of questions and prompts to fill out the information in your ReadMe.md file.
This project features the ability to automatically create a README.md file using prompts. The website will log your responses and automatically format them into a ReadMe file.
- Node.js
- Inquirer
- HTML, CSS, JS
Because you need a JavaScript reader to use this program, I provided a walkthrough demonstration for how to use this through Node.js. Please find the link to that video below:
https://drive.google.com/file/d/1lQMeHiZak5NgvFHEV8PJTJY7vXFC4wJm/view
If you would like to contribute to this project, feel free to contact me through GitHub.
If you have additional questions, please contact the developer at scarlinj@gmail.com.
This project was developed as part of a Web Development program through UC Berkeley.